FlashArray REST API (2.3)

Download OpenAPI specification:Download

Authorization

Pure Storage uses the OAuth 2.0 Token Exchange authorization grant and JSON Web Tokens (JWTs) to authenticate to the Pure Storage REST API. Before you can exchange the ID Token for an access token, create and enable the API client to generate the key_id, id, and issuer values. These values will be used as JWT claims for the subject_token parameter.

Get access token

Exchanges an ID Token for an OAuth 2.0 access token.

Request Body schema: application/x-www-form-urlencoded

grant_type

required

string

Default: "urn:ietf:params:oauth:grant-type:token-exchange"

The method by which the access token will be obtained. The Pure Storage REST API supports the OAuth 2.0 "token exchange" grant type, which indicates that a token exchange is being performed. Set grant_type to urn:ietf:params:oauth:grant-type:token-exchange.

subject_token

required

string

An encoded security ID Token representing the identity of the party on behalf of whom the request is being made. The token must be issued by a trusted identity provider which must be either a registered application in Pure1 or an enabled API client on the array. The token must be a JSON Web Token and must contain the following claims:

JWT claim Location API Client Field Description Required By

kid Header key_id Key ID of the API client that issues the identity token. FlashArray and FlashBlade only.

aud Payload id Client ID of the API client that issues the identity token. FlashArray and FlashBlade only.

sub Payload Login name of the array user for whom the token should be issued. This must be a valid user in the system. FlashArray and FlashBlade only.

iss Payload issuer Application ID for the Pure1 or API client's trusted identity issuer on the array. All products.

iat Payload Timestamp of when the identity token was issued. Measured in milliseconds since the UNIX epoch. All products.

exp Payload Timestamp of when the identity token will expire. Measured in milliseconds since the UNIX epoch. All products.

Each token must also be signed with the private key that is paired with the API client's public key.

subject_token_type

required

string

Default: "urn:ietf:params:oauth:token-type:jwt"

An identifier that indicates the type of security token specifed in the subject_token parameter. The Pure Storage REST API supports the JSON Web Token (JWT) as the means for requesting the access token. Set subject_token_type to urn:ietf:params:oauth:token-type:jwt.

Responses

200

400

BAD REQUEST

401

UNAUTHORIZED

post /oauth2/1.0/token

/oauth2/1.0/token

Response samples

application/json

Copy

Expand all Collapse all

{

"access_token": "eyJraWQiOiJqTlBzL1Ria2c4U2Vua3F3ZmkvbnI4bWxxQ3NPIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJhdWQiOiI5NDcyMTkwOC1mNzkyLTcxMmUtYTYzOS0wODM5ZmE4MzA5MjIiLCJzdWIiOiJqb2UiLCJyb2xlIjoic3RvcmFnZV9hZG1pbiIsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6OTAwMCIsImlhdCI6MTU0NDAzNjA1MiwiZXhwIjoxNTQ0MDcyMDUyLCJqdGkiOiJjOTg0MjgyNS1mNGM3LTRiNGUtODdkNy03OWFiZmIxYTUzNDgifQ.pnuYAx0CkmkIG0LDrMAQGRr5Ci4-t5yMto3A7BkmyKnAVHBXG5ZIWwvNkWDLhqbA4YjmG7LZmWHrCVehLy2zy2vRLahFURsd3GTnOaWSyWFIyrwpoO81jQRtOQATtseweuMT_-C8o3oa4MgBNBsuKrhwKQS3oDDpeRPaCRTGev1_xRDxh_K6CWJBTAeOP2pcR4LW6zIJkCLzzkMuyL4aTJWWUjSbl04mcFbyw8r8W1GURrmaDVOvvpT634Hk9-GGh9OMIRlS6OOq7cJKc-RRWn18IK2Gs53V_KYshXTBbnRr990Y_qOX8MaTWOJTqgzsojY02MSVuJ9XDJWoIU3TQytr4K1vM2EvwDZDgl7LuUYUn7vWhbKktFzpeZyyhOjq3eX-ViugYKpIjBcG2f_-fcTPceEWGV82rd6TyVNB5A-v9u2kxCdW198t_kesgVQfuupDeS02cZe0ABLCzEHPiVF17JfiVr6sjkciioxN7Wj_j18ga4U0mdSukauT8yhbgCW1ijTVTFu1VwWebW0s8z3BWMtXdTtZ3BhcZVAdKRF8bOq7nfEbUQGhTn9g7dK-yF050winjtp-VTL2oUtkF5j1v_N8vPNiN9ZdkGJZr7VVZ-qeOJZcjdaRbxL6YB__yT1wkTcKPh8RHz6GUq7Jbyw8VIlcBE2nvJ63d0tH9C4",
"issued_token_type": "urn:ietf:params:oauth:token-type:access_token",
"token_type": "Bearer",
"expires_in": 35999

}

List available API versions

Returns a list of available API versions. No authentication is required to access this endpoint.

Responses

200

get /api/api_version

/api/api_version

Response samples

application/json

Copy

Expand all Collapse all

{

"version":
[
- "1.0",
- "1.1",
- "1.2",
- "1.3",
- "1.4",
- "1.5",
- "1.6",
- "1.7",
- "1.8",
- "1.9",
- "1.10",
- "1.11",
- "1.12",
- "1.13",
- "1.14",
- "1.15",
- "1.16",
- "1.17",
- "2.0"
]

}

POST login (placeholder)

Exchange an API token for a session token.

header Parameters

api-token

string

Example: "0f2e2884-9486-c6c2-438c-f50418f2aac3"

API token for a user.

Responses

200

post /api/2.3/login

/api/2.3/login

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "username": "pureuser"
  }
]

}

POST logout (placeholder)

Invalidate a session token.

header Parameters

x-auth-token

string

Example: "3be3d489-55c6-4643-90ac-a476dbc98812"

Session token for a user.

Responses

200

post /api/2.3/logout

/api/2.3/logout

Active Directory

Active Directory endpoint description (placeholder)

List Active Directory accounts

Displays a list of Active Directory accounts.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/active-directory

/api/2.3/active-directory

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "name": "string",
  - "computer_name": "FLASHARRAY01",
  - "directory_servers":
    [
    "ldap.my-corporation.com"
    ],
  - "domain": "my-corporation.com",
  - "kerberos_servers":
    [
    "kdc.my-corporation.com"
    ]
  }
]

}

Delete Active Directory members

Deletes one or more Active Directory members.

query Parameters

local_only	boolean If specified as `true`, only delete the Active Directory configuration on the local array, without deleting the computer account created in the Active Directory domain. If not specified, defaults to `false`.
names required	Array of strings Performs the operation on the unique name specified. For example, `name01`. Enter multiple names in comma-separated format.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/active-directory

/api/2.3/active-directory

Create Active Directory member

Creates Active Directory members.

query Parameters

names

required

Array of strings

Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

computer_name	string The name of the computer account to be created in the Active Directory domain. If not specified, defaults to the name of the Active Directory configuration.
directory_servers	Array of strings <= 1 characters A list of directory servers used for lookups related to user authorization. Accepted server formats are IP address and DNS name. All specified servers must be registered to the domain appropriately in the configured DNS of the array and are only communicated with over the secure LDAP (LDAPS) protocol. If not specified, servers are resolved for the domain in DNS. The specified list can have a maximum length of 1.
domain	string The Active Directory domain to join.
kerberos_servers	Array of strings <= 1 characters A list of key distribution servers to use for Kerberos protocol. Accepted server formats are IP address and DNS name. All specified servers must be registered to the domain appropriately in the configured DNS of the array. If not specified, servers are resolved for the domain in DNS. The specified list can have a maximum length of 1.
password	string The login password of the user with privileges to create the computer account in the domain. This is not persisted on the array.
user	string The login name of the user with privileges to create the computer account in the domain. This is not persisted on the array.

Responses

200

post /api/2.3/active-directory

/api/2.3/active-directory

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"computer_name": "FLASHARRAY01",
"directory_servers":
[
- "ldap.my-corporation.com"
],
"domain": "my-corporation.com",
"kerberos_servers":
[
- "kdc.my-corporation.com"
],
"password": "password",
"user": "Administrator"

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "name": "string",
  - "computer_name": "FLASHARRAY01",
  - "directory_servers":
    [
    "ldap.my-corporation.com"
    ],
  - "domain": "my-corporation.com",
  - "kerberos_servers":
    [
    "kdc.my-corporation.com"
    ]
  }
]

}

Administrators

Administrators endpoint description (placeholder)

List administrators

Displays a list of administrators.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
expose_api_token	boolean If `true`, exposes the API token of the current user.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/admins

/api/2.3/admins

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "name": "string",
  - "api_token":
    {
    "created_at": 0,
    "expires_at": 0,
    "token": "string"
    },
  - "is_local": true,
  - "locked": false,
  - "lockout_remaining": 0,
  - "password": "string",
  - "public_key": "string",
  - "role":
    {
    "name": "string"
    }
  }
]

}

Create an administrator

Creates an administrator.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

password	string Password associated with the account.
role	object dummy

Responses

200

post /api/2.3/admins

/api/2.3/admins

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"password": "string",
"role":
{
- "name": "string"
}

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "name": "string",
  - "api_token":
    {
    "created_at": 0,
    "expires_at": 0,
    "token": "string"
    },
  - "is_local": true,
  - "locked": false,
  - "lockout_remaining": 0,
  - "password": "string",
  - "public_key": "string",
  - "role":
    {
    "name": "string"
    }
  }
]

}

Deletes an administrator

Deletes the specified administrator.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/admins

/api/2.3/admins

Modify an administrator

Modifies properties for the specified administrator.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

locked	boolean Returns a value of `true` if the user is currently locked out, otherwise `false`. Can be patched to `false` to unlock a user. This field is only visible to `array_admin` roles. For all other users, the value is always `null`.
password	string Password associated with the account.
public_key	string Public key for SSH access.
role	object dummy
old_password	string The current password.

Responses

200

patch /api/2.3/admins

/api/2.3/admins

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"locked": false,
"password": "string",
"public_key": "string",
"role":
{
- "name": "string"
},
"old_password": "string"

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "name": "string",
  - "api_token":
    {
    "created_at": 0,
    "expires_at": 0,
    "token": "string"
    },
  - "is_local": true,
  - "locked": false,
  - "lockout_remaining": 0,
  - "password": "string",
  - "public_key": "string",
  - "role":
    {
    "name": "string"
    }
  }
]

}

List API tokens

Displays API tokens for the specified administrators.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
expose_api_token	boolean If `true`, exposes the API token of the current user.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/admins/api-tokens

/api/2.3/admins/api-tokens

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "name": "string",
  - "api_token":
    {
    "created_at": 0,
    "expires_at": 0,
    "token": "string"
    }
  }
]

}

Create API tokens

Creates API tokens for the specified administrators.

query Parameters

names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
timeout	integer <int64> The duration of API token validity, in milliseconds.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

post /api/2.3/admins/api-tokens

/api/2.3/admins/api-tokens

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "name": "string",
  - "api_token":
    {
    "created_at": 0,
    "expires_at": 0,
    "token": "string"
    }
  }
]

}

Delete API tokens

Deletes the API tokens of the specified administrators.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/admins/api-tokens

/api/2.3/admins/api-tokens

List administrator cache entries

Displays entries in the administrator cache.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/admins/cache

/api/2.3/admins/cache

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "name": "string",
  - "cached_at": 0,
  - "role":
    {
    "name": "string"
    }
  }
]

}

Delete cache entries

Deletes all entries from the administrator cache.

query Parameters

remove_all_entries

required

boolean

If set to true, removes all entries from the administrator cache.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/admins/cache

/api/2.3/admins/cache

Update or refresh entries in the administrator cache

Updates entries in the cache for administrators who currently do not have a cache entry, otherwise refreshes the existing entry.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

put /api/2.3/admins/cache

/api/2.3/admins/cache

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "name": "string",
  - "cached_at": 0,
  - "role":
    {
    "name": "string"
    }
  }
]

}

List administrator settings

Displays the global administrator settings for the array.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/admins/settings

/api/2.3/admins/settings

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "lockout_duration": 3600000,
  - "max_login_attempts": 10,
  - "min_password_length": 1,
  - "single_sign_on_enabled": true
  }
]

}

Modify administrator settings

Modifies the global administrator settings for the array.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

lockout_duration	integer <int64> [ 1000 .. 7776000000 ] The lockout duration, in milliseconds, if a user is locked out after reaching the maximum number of login attempts. Ranges from 1 second to 90 days.
max_login_attempts	integer <int32> [ 1 .. 20 ] Maximum number of failed login attempts allowed before the user is locked out.
min_password_length	integer <int32> Minimum password length. If not specified, defaults to 1.
single_sign_on_enabled	boolean If `true`, then single sign-on is enabled for the array.

Responses

200

patch /api/2.3/admins/settings

/api/2.3/admins/settings

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"lockout_duration": 3600000,
"max_login_attempts": 10,
"min_password_length": 1,
"single_sign_on_enabled": true

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "lockout_duration": 3600000,
  - "max_login_attempts": 10,
  - "min_password_length": 1,
  - "single_sign_on_enabled": true
  }
]

}

Alerts

Alerts endpoint description (placeholder)

List alerts

Displays a list of alerts.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
flagged	boolean If set to `true`, lists only flagged messages. If set to `false`, lists only unflagged messages. if not specified, lists all messages.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/alerts

/api/2.3/alerts

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "actual": "95%",
  - "category": "array",
  - "closed": 1578440492342,
  - "code": 7,
  - "component_name": "vm-tom",
  - "component_type": "storage",
  - "created": 1576275532434,
  - "description": "boot drive overutilization",
  - "expected": "90%",
  - "flagged": true,
  - "issue": "boot drive overutilization",
  - "knowledge_base_url": "https://support.purestorage.com/?cid=Alert_0007",
  - "notified": 1578440491109,
  - "severity": "critical",
  - "state": "open",
  - "summary": "boot drive overutilization",
  - "updated": 1578440491109
  }
]

}

Modify flagged state

Modifies one or more alerts and display updated information about these alerts.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

flagged

boolean

If set to true, the message is flagged. Important messages can can be flagged and listed separately.

Responses

200

patch /api/2.3/alerts

/api/2.3/alerts

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"flagged": true

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "actual": "95%",
  - "category": "array",
  - "closed": 1578440492342,
  - "code": 7,
  - "component_name": "vm-tom",
  - "component_type": "storage",
  - "created": 1576275532434,
  - "description": "boot drive overutilization",
  - "expected": "90%",
  - "flagged": true,
  - "issue": "boot drive overutilization",
  - "knowledge_base_url": "https://support.purestorage.com/?cid=Alert_0007",
  - "notified": 1578440491109,
  - "severity": "critical",
  - "state": "open",
  - "summary": "boot drive overutilization",
  - "updated": 1578440491109
  }
]

}

List alert events

Displays a list of alert events.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
flagged	boolean If set to `true`, lists only flagged messages. If set to `false`, lists only unflagged messages. if not specified, lists all messages.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. For example, `name01`. Enter multiple names in comma-separated format. The `ids` or `names` parameter is required, but both cannot be set together.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/alerts/events

/api/2.3/alerts/events

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "name": "string",
  - "actual": "95%",
  - "alert":
    {
    "id": "string",
    "name": "string"
    },
  - "code": 7,
  - "component_name": "vm-tom",
  - "component_type": "storage",
  - "created": 1576275532434,
  - "expected": "90%",
  - "issue": "boot drive overutilization",
  - "knowledge_base_url": "https://support.purestorage.com/?cid=Alert_0007",
  - "severity": "critical",
  - "state": "open",
  - "summary": "boot drive overutilization",
  - "time": 1578440491109
  }
]

}

API Clients

An API client represents an identity type. API clients are created on the array. To create an API client, register and then enable it on the array. After the API client has been created, the user name (sub) and identity tokens (kid and aud tokens) that are issued by the API client are used as claims for the JSON Web Token that you create to authenticate into the REST API.

List API clients

Returns a list of API clients.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/api-clients

/api/2.3/api-clients

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "6207d123-d123-0b5c-5fa1-95fabc5c7123",
  - "name": "NightlyStatsAggregationScript",
  - "max_role": "storage_admin",
  - "issuer": "https://purestorage.idp.okta.com",
  - "public_key": "-----BEGIN PUBLIC KEY----- MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEArSe6chh1JzME9svOKjU0 eKTm8S23Ok3Vr2bWuPri/YHfLrlnRwWoCt+st0/BebKSJ+fQUWOaLlqpZQKpI8oR gJ9sWmwGibVG8cTuz7XMkskx9bsm/bjIenuB4W+s3g0BCsi9930mfdKgJgFzY69O nLh7d7hAFcmhSJa945PryQZpvJ/U4Ue5F4d+WXgEJ0SoSRaZ6bbeMPhcbMHTzTum 2ZrPBkK5cqPYitaso6BXeAlqNQPw4Kbu4Ugm0CTogrtImkwoonWDDP34XMOq+u7q sNTbJSvDKMTM1RPPrTWCaLiuZkdLVEVesZ9/8+XUMIgBTElwQJDCAQer03MJzqRr 1eCZGgLfDuYqwMG2MFaAX7kgqBwwyqRTd6MxaQxt2nkdfwiXSY71llzEQ23g3T+1 64zjwAL5f+dtu8PkGF7IdU2T8P2Qk9bG9pckwZHWYkBK77BAk5jbmSzsKGZgRb2R 1E+TWDKIaveFhQp251j/C5wkZwMXgjOzN+BOPo+OiLBGUl+jRybWA9f7Vq1MEdf6 SEdLiqYrXcZERkYBMieLXAfdtaztAIb96cUu+OKMSLDk+D0GHkUfm7lEbDK3ew1+ D6z+BnxDyH6oqZzz4lS2kPLBLsc+6pdTGuKLf0S9YuLiqJe659AdwU8+X/3KtwNd FVJSaxdFbWx0nj3hJqFkIO8CAwEAAQ== -----END PUBLIC KEY-----",
  - "key_id": "6207d123-d123-0b5c-5fa1-95fabc5c7123",
  - "enabled": true,
  - "access_token_ttl_in_ms": 15000
  }
]

}

Create an API client

Creates an API client. Newly created API clients are disabled by default. Enable an API client through the PATCH method. The names, max_role, issuer, and public_key parameters are required.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

max_role	string The maximum role allowed for ID Tokens issued by this API client. The bearer of an access token will be authorized to perform actions within the intersection of this `max_role` and the role of the array user specified as the `sub`. Valid values are `array_admin`, `storage_admin`, `ops_admin`, and `readonly`. Users with the `readonly` (Read Only) role can perform operations that convey the state of the array. Read Only users cannot alter the state of the array. Users with the `ops_admin` (Ops Admin) role can perform the same operations as Read Only users plus enable and disable remote assistance sessions. Ops Admin users cannot alter the state of the array. Users with the `storage_admin` (Storage Admin) role can perform the same operations as Read Only users plus storage related operations, such as administering volumes, hosts, and host groups. Storage Admin users cannot perform operations that deal with global and system configurations. Users with the `array_admin` (Array Admin) role can perform the same operations as Storage Admin users plus array-wide changes dealing with global and system configurations. In other words, Array Admin users can perform all operations.
issuer	string The name of the identity provider that will be issuing ID Tokens for this API client. The `iss` claim in the JWT issued must match this string. If not specified, defaults to the API client name.
public_key	string The API client's PEM formatted (Base64 encoded) RSA public key. Include the `-----BEGIN PUBLIC KEY-----` and `-----END PUBLIC KEY-----` lines.
access_token_ttl_in_ms	integer <int64> The TTL (Time To Live) length of time for the exchanged access token. Measured in milliseconds. If not specified, defaults to `86400000`.

Responses

200

post /api/2.3/api-clients

/api/2.3/api-clients

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"max_role": "storage_admin",
"issuer": "https://purestorage.idp.okta.com",
"public_key": "-----BEGIN PUBLIC KEY----- MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEArSe6chh1JzME9svOKjU0 eKTm8S23Ok3Vr2bWuPri/YHfLrlnRwWoCt+st0/BebKSJ+fQUWOaLlqpZQKpI8oR gJ9sWmwGibVG8cTuz7XMkskx9bsm/bjIenuB4W+s3g0BCsi9930mfdKgJgFzY69O nLh7d7hAFcmhSJa945PryQZpvJ/U4Ue5F4d+WXgEJ0SoSRaZ6bbeMPhcbMHTzTum 2ZrPBkK5cqPYitaso6BXeAlqNQPw4Kbu4Ugm0CTogrtImkwoonWDDP34XMOq+u7q sNTbJSvDKMTM1RPPrTWCaLiuZkdLVEVesZ9/8+XUMIgBTElwQJDCAQer03MJzqRr 1eCZGgLfDuYqwMG2MFaAX7kgqBwwyqRTd6MxaQxt2nkdfwiXSY71llzEQ23g3T+1 64zjwAL5f+dtu8PkGF7IdU2T8P2Qk9bG9pckwZHWYkBK77BAk5jbmSzsKGZgRb2R 1E+TWDKIaveFhQp251j/C5wkZwMXgjOzN+BOPo+OiLBGUl+jRybWA9f7Vq1MEdf6 SEdLiqYrXcZERkYBMieLXAfdtaztAIb96cUu+OKMSLDk+D0GHkUfm7lEbDK3ew1+ D6z+BnxDyH6oqZzz4lS2kPLBLsc+6pdTGuKLf0S9YuLiqJe659AdwU8+X/3KtwNd FVJSaxdFbWx0nj3hJqFkIO8CAwEAAQ== -----END PUBLIC KEY-----",
"access_token_ttl_in_ms": 15000

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "id": "6207d123-d123-0b5c-5fa1-95fabc5c7123",
  - "name": "NightlyStatsAggregationScript",
  - "max_role": "storage_admin",
  - "issuer": "https://purestorage.idp.okta.com",
  - "public_key": "-----BEGIN PUBLIC KEY----- MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEArSe6chh1JzME9svOKjU0 eKTm8S23Ok3Vr2bWuPri/YHfLrlnRwWoCt+st0/BebKSJ+fQUWOaLlqpZQKpI8oR gJ9sWmwGibVG8cTuz7XMkskx9bsm/bjIenuB4W+s3g0BCsi9930mfdKgJgFzY69O nLh7d7hAFcmhSJa945PryQZpvJ/U4Ue5F4d+WXgEJ0SoSRaZ6bbeMPhcbMHTzTum 2ZrPBkK5cqPYitaso6BXeAlqNQPw4Kbu4Ugm0CTogrtImkwoonWDDP34XMOq+u7q sNTbJSvDKMTM1RPPrTWCaLiuZkdLVEVesZ9/8+XUMIgBTElwQJDCAQer03MJzqRr 1eCZGgLfDuYqwMG2MFaAX7kgqBwwyqRTd6MxaQxt2nkdfwiXSY71llzEQ23g3T+1 64zjwAL5f+dtu8PkGF7IdU2T8P2Qk9bG9pckwZHWYkBK77BAk5jbmSzsKGZgRb2R 1E+TWDKIaveFhQp251j/C5wkZwMXgjOzN+BOPo+OiLBGUl+jRybWA9f7Vq1MEdf6 SEdLiqYrXcZERkYBMieLXAfdtaztAIb96cUu+OKMSLDk+D0GHkUfm7lEbDK3ew1+ D6z+BnxDyH6oqZzz4lS2kPLBLsc+6pdTGuKLf0S9YuLiqJe659AdwU8+X/3KtwNd FVJSaxdFbWx0nj3hJqFkIO8CAwEAAQ== -----END PUBLIC KEY-----",
  - "key_id": "6207d123-d123-0b5c-5fa1-95fabc5c7123",
  - "enabled": true,
  - "access_token_ttl_in_ms": 15000
  }
]

}

Manage an API client

Enables or disables an API client. The ids or names parameter is required, but cannot be set together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

enabled

boolean

Returns a value of true if the API client is permitted to exchange ID tokens for access tokens. API clients are disabled by default.

Responses

200

patch /api/2.3/api-clients

/api/2.3/api-clients

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"enabled": true

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "id": "6207d123-d123-0b5c-5fa1-95fabc5c7123",
  - "name": "NightlyStatsAggregationScript",
  - "max_role": "storage_admin",
  - "issuer": "https://purestorage.idp.okta.com",
  - "public_key": "-----BEGIN PUBLIC KEY----- MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEArSe6chh1JzME9svOKjU0 eKTm8S23Ok3Vr2bWuPri/YHfLrlnRwWoCt+st0/BebKSJ+fQUWOaLlqpZQKpI8oR gJ9sWmwGibVG8cTuz7XMkskx9bsm/bjIenuB4W+s3g0BCsi9930mfdKgJgFzY69O nLh7d7hAFcmhSJa945PryQZpvJ/U4Ue5F4d+WXgEJ0SoSRaZ6bbeMPhcbMHTzTum 2ZrPBkK5cqPYitaso6BXeAlqNQPw4Kbu4Ugm0CTogrtImkwoonWDDP34XMOq+u7q sNTbJSvDKMTM1RPPrTWCaLiuZkdLVEVesZ9/8+XUMIgBTElwQJDCAQer03MJzqRr 1eCZGgLfDuYqwMG2MFaAX7kgqBwwyqRTd6MxaQxt2nkdfwiXSY71llzEQ23g3T+1 64zjwAL5f+dtu8PkGF7IdU2T8P2Qk9bG9pckwZHWYkBK77BAk5jbmSzsKGZgRb2R 1E+TWDKIaveFhQp251j/C5wkZwMXgjOzN+BOPo+OiLBGUl+jRybWA9f7Vq1MEdf6 SEdLiqYrXcZERkYBMieLXAfdtaztAIb96cUu+OKMSLDk+D0GHkUfm7lEbDK3ew1+ D6z+BnxDyH6oqZzz4lS2kPLBLsc+6pdTGuKLf0S9YuLiqJe659AdwU8+X/3KtwNd FVJSaxdFbWx0nj3hJqFkIO8CAwEAAQ== -----END PUBLIC KEY-----",
  - "key_id": "6207d123-d123-0b5c-5fa1-95fabc5c7123",
  - "enabled": true,
  - "access_token_ttl_in_ms": 15000
  }
]

}

Delete an API client

Deletes an API client. The ids or names parameter is required, but cannot be set together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/api-clients

/api/2.3/api-clients

Apps

Apps endpoint description (placeholder)

List apps

Displays a list of installed apps.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/apps

/api/2.3/apps

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "name": "string",
  - "description": "Snapshot offload to NFS or Amazon S3",
  - "enabled": true,
  - "status": "healthy",
  - "version": "1.0.0",
  - "details": "Insufficient resources to operate",
  - "vnc_enabled": true
  }
]

}

Modify app

Modifies an installed app or modifies Virtual Network Computing (VNC) access for apps that are being patched.

query Parameters

names

required

Array of strings

Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

enabled	boolean If set to `true`, the app is enabled. By default, apps are disabled.
vnc_enabled	boolean If set to `true`, VNC access is enabled. By default, VNC access is disabled.

Responses

200

patch /api/2.3/apps

/api/2.3/apps

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"enabled": true,
"vnc_enabled": true

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "name": "string",
  - "description": "Snapshot offload to NFS or Amazon S3",
  - "enabled": true,
  - "status": "healthy",
  - "version": "1.0.0",
  - "details": "Insufficient resources to operate",
  - "vnc_enabled": true
  }
]

}

List app nodes

Displays a list of installed apps and their nodes.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
app_names	Array of strings The name of the installed app. Enter multiple names in comma-separated format.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/apps/nodes

/api/2.3/apps/nodes

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "app":
    {
    "id": "string",
    "name": "string"
    },
  - "index": 0,
  - "status": "healthy",
  - "version": "1.0.0",
  - "vnc":
    [
    "10.1.1.10:5900"
    ]
  }
]

}

Arrays

Arrays endpoint description (placeholder)

List arrays

Displays a list of arrays.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/arrays

/api/2.3/arrays

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "banner": "Restricted area. Authorized personnel only.",
  - "capacity": 10995116277760,
  - "console_lock_enabled": false,
  - "idle_timeout": 300000,
  - "ntp_servers":
    [
    "time.acme.com"
    ],
  - "os": "Purity//FA",
  - "parity": 0.99,
  - "scsi_timeout": 60000,
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0,
    "replication": 0
    },
  - "version": "5.0.0"
  }
]

}

Modify an array

Modifies general array properties including the array name, login banner, idle timeout for management sessions, and NTP servers.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

name	string A user-specified name. The name must be locally unique and can be changed.
banner	string
console_lock_enabled	boolean
idle_timeout	integer <int32> Idle timeout in milliseconds. Valid values are `0` and any multiple of 60000 in the range of 300000 and 10800000. Any other values will be rounded down to the nearest multiple of 60000.
ntp_servers	Array of strings
scsi_timeout	integer <int32> The SCSI timeout. This value defaults to 60s if it is not specified.

Responses

200

patch /api/2.3/arrays

/api/2.3/arrays

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"name": "string",
"banner": "Restricted area. Authorized personnel only.",
"console_lock_enabled": false,
"idle_timeout": 300000,
"ntp_servers":
[
- "time.acme.com"
],
"scsi_timeout": 60000

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "banner": "Restricted area. Authorized personnel only.",
  - "capacity": 10995116277760,
  - "console_lock_enabled": false,
  - "idle_timeout": 300000,
  - "ntp_servers":
    [
    "time.acme.com"
    ],
  - "os": "Purity//FA",
  - "parity": 0.99,
  - "scsi_timeout": 60000,
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0,
    "replication": 0
    },
  - "version": "5.0.0"
  }
]

}

List End User Agreement and signature

Displays the End User Agreement and signature.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/arrays/eula

/api/2.3/arrays/eula

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "agreement": "string",
  - "signature":
    {
    "name": "John Doe",
    "title": "Admin",
    "company": "Example Inc.",
    "accepted": 1577880000000
    }
  }
]

}

Modify signature on the End User Agreement

Modifies the signature on the End User Agreement.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

signature

object

Responses

200

patch /api/2.3/arrays/eula

/api/2.3/arrays/eula

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"signature":
{
- "name": "John Doe",
- "title": "Admin",
- "company": "Example Inc."
}

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "agreement": "string",
  - "signature":
    {
    "name": "John Doe",
    "title": "Admin",
    "company": "Example Inc.",
    "accepted": 1577880000000
    }
  }
]

}

List NTP test results

Displays test results for configured NTP servers.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/arrays/ntp-test

/api/2.3/arrays/ntp-test

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "component_address": "10.230.94.21",
  - "component_name": "CT0",
  - "description": "Testing phonehome connectivity",
  - "destination": "ra.cloud-support.purestorage.com",
  - "enabled": true,
  - "result_details": "Timeout connecting to phonehome endpoint",
  - "success": true,
  - "test_type": "phonehome"
  }
]

}

List array front-end performance data

Displays real-time and historical front-end performance data at the array level including latency, bandwidth, IOPS, average I/O size, and queue depth.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
end_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
resolution	integer <int64> >= 0 Example: 30000 The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`<object name>/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`<object name>/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution.
start_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
protocol	string Protocol type. Valid values are `nfs`, `smb`, and `all`.
protocol_group	string Protocol group type. Valid values are `block`, `file`, and `all`.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/arrays/performance

/api/2.3/arrays/performance

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "bytes_per_mirrored_write": 0,
  - "bytes_per_op": 0,
  - "bytes_per_read": 0,
  - "bytes_per_write": 0,
  - "mirrored_write_bytes_per_sec": 0,
  - "mirrored_writes_per_sec": 0,
  - "qos_rate_limit_usec_per_mirrored_write_op": 0,
  - "qos_rate_limit_usec_per_read_op": 0,
  - "qos_rate_limit_usec_per_write_op": 0,
  - "queue_usec_per_mirrored_write_op": 0,
  - "queue_usec_per_read_op": 0,
  - "queue_usec_per_write_op": 0,
  - "read_bytes_per_sec": 0,
  - "reads_per_sec": 0,
  - "san_usec_per_mirrored_write_op": 0,
  - "san_usec_per_read_op": 0,
  - "san_usec_per_write_op": 0,
  - "service_usec_per_mirrored_write_op": 0,
  - "service_usec_per_read_op": 0,
  - "service_usec_per_write_op": 0,
  - "time": 0,
  - "usec_per_mirrored_write_op": 0,
  - "usec_per_read_op": 0,
  - "usec_per_write_op": 0,
  - "write_bytes_per_sec": 0,
  - "writes_per_sec": 0,
  - "queue_depth": 0,
  - "local_queue_usec_per_op": 0,
  - "usec_per_other_op": 0,
  - "others_per_sec": 0
  }
]

}

List array space information

Displays real-time and historical array space information including unique volume and snapshot space, shared space, data reduction, provisioned capacity, usable capacity, and parity.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
end_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
resolution	integer <int64> >= 0 Example: 30000 The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`<object name>/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`<object name>/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution.
start_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/arrays/space

/api/2.3/arrays/space

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "capacity": 10995116277760,
  - "parity": 0.99,
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0,
    "replication": 0
    },
  - "time": 0
  }
]

}

Audits

Audits endpoint description (placeholder)

List audits

Displays a list of audits.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/audits

/api/2.3/audits

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "arguments": "--size 1G vol2",
  - "command": "purevol",
  - "origin":
    {
    "id": "string",
    "name": "string"
    },
  - "subcommand": "create",
  - "time": 1577402821354,
  - "user": "pureuser",
  - "user_interface": "CLI"
  }
]

}

Connections

A connection gives hosts access to volumes on the array. The system supports private (host-volume) connections and public (host group-volume) connections. A private connection connects one volume to one host. Private connections are typically used for boot volumes and for stand-alone (non-clustered) host applications. A shared connection connects a designated set of hosts (via a host group) to a designated set of volumes, providing the hosts with a consistent "view" of the volumes. All associated hosts use the same LUN to address a given associated volume. All hosts and volumes associated with a host group are automatically connected to each other by virtue of their associations with the group. Shared connections are useful for cluster applications in which several related hosts require consistent (same LUN) connectivity to a set of storage volumes.

List volume connections

Displays a list of connections between a volume and its hosts and host groups, and the logical unit numbers (LUNs) used by the associated hosts to address these volumes.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
host_group_names	Array of strings Performs the operation on the host group specified. Enter multiple names in comma-separated format. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple host group names and volume names; instead, at least one of the objects (e.g., `host_group_names`) must be set to only one name (e.g., `hgroup01`).
host_names	Array of strings Performs the operation on the hosts specified. Enter multiple names in comma-separated format. For example, `host01,host02`. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple host names and volume names; instead, at least one of the objects (e.g., `host_names`) must be set to only one name (e.g., `host01`).
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
protocol_endpoint_names	Array of strings Performs the operation on the protocol endpoints specified. Enter multiple names in comma-separated format. For example, `pe01,pe02`. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple protocol endpoint names and host names; instead, at least one of the objects (e.g., `protocol_endpoint_names`) must be set to one name (e.g., `pe01`).
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
volume_names	Array of strings Performs the operation on the volume specified. Enter multiple names in comma-separated format. For example, `vol01,vol02`. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple volume names and host names; instead, at least one of the objects (e.g., `volume_names`) must be set to only one name (e.g., `vol01`).

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/connections

/api/2.3/connections

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "host":
    {
    "name": "string"
    },
  - "host_group":
    {
    "name": "string"
    },
  - "lun": 7,
  - "protocol_endpoint":
    {
    "id": "string",
    "name": "string"
    },
  - "volume":
    {
    "id": "string",
    "name": "string"
    }
  }
]

}

Create a connection between a volume and host or host group

Creates a connection between a volume and a host or host group. The volume_names and host_names or host_group_names query parameters are required.

query Parameters

host_group_names	Array of strings Performs the operation on the host group specified. Enter multiple names in comma-separated format. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple host group names and volume names; instead, at least one of the objects (e.g., `host_group_names`) must be set to only one name (e.g., `hgroup01`).
host_names	Array of strings Performs the operation on the hosts specified. Enter multiple names in comma-separated format. For example, `host01,host02`. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple host names and volume names; instead, at least one of the objects (e.g., `host_names`) must be set to only one name (e.g., `host01`).
volume_names	Array of strings Performs the operation on the volume specified. Enter multiple names in comma-separated format. For example, `vol01,vol02`. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple volume names and host names; instead, at least one of the objects (e.g., `volume_names`) must be set to only one name (e.g., `vol01`).

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

lun

integer <int32> [ 1 .. 4095 ]

The logical unit number (LUN) by which the specified hosts are to address the specified volume. If the LUN is not specified, the system automatically assigns a LUN to the connection. To automatically assign a LUN to a private connection, the system starts at LUN 1 and counts up to the maximum LUN 4095, assigning the first available LUN to the connection. For shared connections, the system starts at LUN 254 and counts down to the minimum LUN 1, assigning the first available LUN to the connection. If all LUNs in the [1...254] range are taken, the system starts at LUN 255 and counts up to the maximum LUN 4095, assigning the first available LUN to the connection.

protocol_endpoint

object

A protocol endpoint (also known as a conglomerate volume) which acts as a proxy through which virtual volumes are created and then connected to VMware ESXi hosts or host groups. The protocol endpoint itself does not serve I/Os; instead, its job is to form connections between FlashArray volumes and ESXi hosts and host groups.

Responses

200

post /api/2.3/connections

/api/2.3/connections

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"lun": 7,
"protocol_endpoint":
{
- "id": "string",
- "name": "string"
}

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "host":
    {
    "name": "string"
    },
  - "host_group":
    {
    "name": "string"
    },
  - "lun": 7,
  - "protocol_endpoint":
    {
    "id": "string",
    "name": "string"
    },
  - "volume":
    {
    "id": "string",
    "name": "string"
    }
  }
]

}

Delete a connection between a volume and its host or host group

Deletes the connection between a volume and its associated host or host group. The volume_names and host_names or host_group_names query parameters are required.

query Parameters

host_group_names	Array of strings Performs the operation on the host group specified. Enter multiple names in comma-separated format. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple host group names and volume names; instead, at least one of the objects (e.g., `host_group_names`) must be set to only one name (e.g., `hgroup01`).
host_names	Array of strings Performs the operation on the hosts specified. Enter multiple names in comma-separated format. For example, `host01,host02`. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple host names and volume names; instead, at least one of the objects (e.g., `host_names`) must be set to only one name (e.g., `host01`).
volume_names	Array of strings Performs the operation on the volume specified. Enter multiple names in comma-separated format. For example, `vol01,vol02`. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple volume names and host names; instead, at least one of the objects (e.g., `volume_names`) must be set to only one name (e.g., `vol01`).

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/connections

/api/2.3/connections

Controllers

Controllers endpoint description (placeholder)

List controller information and status

Displays the name, mode, FlashArray model, Purity//FA software version, and status of each controller in the array.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/controllers

/api/2.3/controllers

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "name": "string",
  - "mode": "primary",
  - "model": "FA-m50",
  - "status": "ready",
  - "type": "string",
  - "version": "5.0.0"
  }
]

}

Directories

Directories endpoint description (placeholder)

List directories

Displays a list of directories, including those pending eradication.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
file_system_ids	Array of strings Performs the operation on the file system ID specified. Enter multiple file system IDs in comma-separated format. The `file_system_ids` and `file_system_names` parameters cannot be provided together.
file_system_names	Array of strings Performs the operation on the file system name specified. Enter multiple file system names in comma-separated format. For example, `filesystem01,filesystem02`.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/directories

/api/2.3/directories

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "created": 0,
  - "destroyed": true,
  - "directory_name": "string",
  - "file_system":
    {
    "id": "string",
    "name": "string"
    },
  - "path": "string",
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "time_remaining": 0
  }
],
"total":
[
- {
  - "id": "string",
  - "name": "string",
  - "created": 0,
  - "destroyed": true,
  - "directory_name": "string",
  - "file_system":
    {
    "id": "string",
    "name": "string"
    },
  - "path": "string",
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "time_remaining": 0
  }
]

}

Create directory

Creates a managed directory at the specified path. The managed directory name must consist of a file system name prefix and a managed directory name suffix (separated with ':'). The suffix must be between 1 and 63 characters (alphanumeric and '-') in length and begin and end with a letter or number. The suffix must include at least one letter or '-'. Either set names to create a managed directory with the specified full managed directory name, or set file_system_names or file_system_ids in the query parameters and suffix in the body parameters to create a managed directory in the specified file system with the specified suffix. These two options are exclusive.

query Parameters

names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
file_system_names	Array of strings Performs the operation on the file system name specified. Enter multiple file system names in comma-separated format. For example, `filesystem01,filesystem02`.
file_system_ids	Array of strings Performs the operation on the file system ID specified. Enter multiple file system IDs in comma-separated format. The `file_system_ids` and `file_system_names` parameters cannot be provided together.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

directory_name	string The managed directory name without the file system name prefix. A full managed directory name is constructed in the form of `FILE_SYSTEM:DIR` where `FILE_SYSTEM` is the file system name and `DIR` is the value of this field. `directory_name` is required if `file_system_names` or `file_system_ids` is set. `directory_name` cannot be set if `names` is set.
path	string Path of the managed directory in the file system.

Responses

200

post /api/2.3/directories

/api/2.3/directories

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"directory_name": "string",
"path": "string"

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "created": 0,
  - "destroyed": true,
  - "directory_name": "string",
  - "file_system":
    {
    "id": "string",
    "name": "string"
    },
  - "path": "string",
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "time_remaining": 0
  }
]

}

Delete managed directories

Deletes one or more managed directories. To be deleted, a managed directory must be empty and not attached to any enabled export policies. Deleted managed directories cannot be recovered. The ids or names parameter is required, but cannot be set together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/directories

/api/2.3/directories

Modify a managed directory

Modifies a managed directory. To rename a managed directory, set name to the new name. The ids or names parameter is required, but cannot be set together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

name	string The new name for the resource.

Responses

200

patch /api/2.3/directories

/api/2.3/directories

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"name": "string"

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "created": 0,
  - "destroyed": true,
  - "directory_name": "string",
  - "file_system":
    {
    "id": "string",
    "name": "string"
    },
  - "path": "string",
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "time_remaining": 0
  }
]

}

List directory performance data

Displays real-time and historical performance data, real-time latency data, and average I/O sizes for each directory and as a total of all directories across the entire array.

query Parameters

destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
end_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
resolution	integer <int64> >= 0 Example: 30000 The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`<object name>/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`<object name>/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution.
start_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
protocol	string Protocol type. Valid values are `nfs`, `smb`, and `all`.
protocol_group	string Protocol group type. Valid values are `block`, `file`, and `all`.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/directories/performance

/api/2.3/directories/performance

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "bytes_per_op": 0,
  - "bytes_per_read": 0,
  - "bytes_per_write": 0,
  - "others_per_sec": 0,
  - "read_bytes_per_sec": 0,
  - "reads_per_sec": 0,
  - "time": 0,
  - "usec_per_other_op": 0,
  - "usec_per_read_op": 0,
  - "usec_per_write_op": 0,
  - "write_bytes_per_sec": 0,
  - "writes_per_sec": 0
  }
],
"total":
[
- {
  - "id": "string",
  - "name": "string",
  - "bytes_per_op": 0,
  - "bytes_per_read": 0,
  - "bytes_per_write": 0,
  - "others_per_sec": 0,
  - "read_bytes_per_sec": 0,
  - "reads_per_sec": 0,
  - "time": 0,
  - "usec_per_other_op": 0,
  - "usec_per_read_op": 0,
  - "usec_per_write_op": 0,
  - "write_bytes_per_sec": 0,
  - "writes_per_sec": 0
  }
]

}

List policies

Displays a list of policies that are attached to directories.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_ids	Array of strings Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` and `member_names` parameters cannot be provided together.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` and `policy_names` parameters cannot be provided together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/directories/policies

/api/2.3/directories/policies

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "destroyed": true,
  - "enabled": true,
  - "member":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    },
  - "policy":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    }
  }
]

}

List NFS policies attached to a directory

Displays a list of NFS policies that are attached to directories.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_ids	Array of strings Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` and `member_names` parameters cannot be provided together.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` and `policy_names` parameters cannot be provided together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/directories/policies/nfs

/api/2.3/directories/policies/nfs

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "destroyed": true,
  - "enabled": true,
  - "member":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    },
  - "policy":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    },
  - "export_name": "string"
  }
]

}

Create a membership between a directory with one or more NFS policies

Creates a membership between a directory with one or more NFS policies. The member_ids or member_names parameter is required but cannot be set together.

query Parameters

member_ids	Array of strings Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` and `member_names` parameters cannot be provided together.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

policies

Array of objects

A list of export policies to apply to the directory. The id and name fields in each policy parameter are required, but cannot be set together.

Responses

200

post /api/2.3/directories/policies/nfs

/api/2.3/directories/policies/nfs

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"policies":
[
- {
  - "export_name": "string",
  - "policy":
    {
    "id": "string",
    "name": "string"
    }
  }
]

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "destroyed": true,
  - "enabled": true,
  - "member":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    },
  - "policy":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    },
  - "export_name": "string"
  }
]

}

Delete a membership between a directory and one or more NFS policies

Deletes a membership between a directory with one or more NFS policies. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

query Parameters

member_ids	Array of strings Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` and `member_names` parameters cannot be provided together.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` and `policy_names` parameters cannot be provided together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/directories/policies/nfs

/api/2.3/directories/policies/nfs

List SMB policies attached to a directory

Displays a list of SMB policies that are attached to directories.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_ids	Array of strings Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` and `member_names` parameters cannot be provided together.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` and `policy_names` parameters cannot be provided together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/directories/policies/smb

/api/2.3/directories/policies/smb

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "destroyed": true,
  - "enabled": true,
  - "member":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    },
  - "policy":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    },
  - "export_name": "string"
  }
]

}

Create a membership between a directory with one or more NFS policies

Creates a membership between a directory with one or more NFS policies. The member_ids or member_names parameter is required, but cannot be set together.

query Parameters

member_ids	Array of strings Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` and `member_names` parameters cannot be provided together.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

policies

Array of objects

A list of export policies to apply to the directory. The id and name fields in each policy parameter are required, but cannot be set together.

Responses

200

post /api/2.3/directories/policies/smb

/api/2.3/directories/policies/smb

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"policies":
[
- {
  - "export_name": "string",
  - "policy":
    {
    "id": "string",
    "name": "string"
    }
  }
]

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "destroyed": true,
  - "enabled": true,
  - "member":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    },
  - "policy":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    },
  - "export_name": "string"
  }
]

}

Delete a membership between a directory and one or more SMB policies

Deletes a membership between a directory with one or more SMB policies. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

query Parameters

member_ids	Array of strings Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` and `member_names` parameters cannot be provided together.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` and `policy_names` parameters cannot be provided together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/directories/policies/smb

/api/2.3/directories/policies/smb

List snapshot policies attached to a directory

Displays a list of snapshot policies that are attached to directories.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_ids	Array of strings Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` and `member_names` parameters cannot be provided together.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` and `policy_names` parameters cannot be provided together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/directories/policies/snapshot

/api/2.3/directories/policies/snapshot

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "destroyed": true,
  - "enabled": true,
  - "member":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    },
  - "policy":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    }
  }
]

}

Create a membership between a directory with one or more snapshot policies

Creates a membership between a directory with one or more snapshot policies. The member_ids or member_names parameter is required, but cannot be set together.

query Parameters

member_ids	Array of strings Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` and `member_names` parameters cannot be provided together.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

policies

Array of objects

A list of policies to apply to the resource. The id and name field in each policy parameter is required, but cannot be set together.

Responses

200

post /api/2.3/directories/policies/snapshot

/api/2.3/directories/policies/snapshot

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"policies":
[
- {
  - "policy":
    {
    "id": "string",
    "name": "string"
    }
  }
]

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "destroyed": true,
  - "enabled": true,
  - "member":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    },
  - "policy":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    }
  }
]

}

Delete a membership between a directory and one or more snapshot policies

Deletes a membership between a directory with one or more snapshot policies. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

query Parameters

member_ids	Array of strings Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` and `member_names` parameters cannot be provided together.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` and `policy_names` parameters cannot be provided together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/directories/policies/snapshot

/api/2.3/directories/policies/snapshot

List directory space information

Displays physical storage consumption data for each directory.

query Parameters

destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
end_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
resolution	integer <int64> >= 0 Example: 30000 The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`<object name>/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`<object name>/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution.
start_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/directories/space

/api/2.3/directories/space

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "time": 0
  }
],
"total":
[
- {
  - "id": "string",
  - "name": "string",
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "time": 0
  }
]

}

Directory Exports

Directory Exports endpoint description (placeholder)

List directory exports

Displays a list of directory exports.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
directory_ids	Array of strings Performs the operation on the unique managed directory IDs specified. Enter multiple managed directory IDs in comma-separated format. The `directory_ids` and `directory_names` parameters cannot be provided together.
directory_names	Array of strings Performs the operation on the managed directory names specified. Enter multiple full managed directory names in comma-separated format. For example, `fs:dir01,fs:dir02`.
export_names	Array of strings Performs the operation on the export names specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` and `policy_names` parameters cannot be provided together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/directory-exports

/api/2.3/directory-exports

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "destroyed": true,
  - "directory":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    },
  - "enabled": true,
  - "export_name": "string",
  - "path": "string",
  - "policy":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    }
  }
]

}

Create directory exports

Creates an export of a managed directory. The directory_ids or directory_names parameter is required, but cannot be set together. The policy_ids or policy_names parameter is required, but cannot be set together.

query Parameters

directory_ids	Array of strings Performs the operation on the unique managed directory IDs specified. Enter multiple managed directory IDs in comma-separated format. The `directory_ids` and `directory_names` parameters cannot be provided together.
directory_names	Array of strings Performs the operation on the managed directory names specified. Enter multiple full managed directory names in comma-separated format. For example, `fs:dir01,fs:dir02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` and `policy_names` parameters cannot be provided together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

export_name

string

The name of the export to create. Export names must be unique within the same protocol.

Responses

200

post /api/2.3/directory-exports

/api/2.3/directory-exports

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"export_name": "string"

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "destroyed": true,
  - "directory":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    },
  - "enabled": true,
  - "export_name": "string",
  - "path": "string",
  - "policy":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    }
  }
]

}

Delete directory exports

Deletes one or more directory exports. If any of the export_names is not unique across the system, policy_ids or policy_names must be specified to determine the exports.

query Parameters

export_names	Array of strings Performs the operation on the export names specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` and `policy_names` parameters cannot be provided together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/directory-exports

/api/2.3/directory-exports

Directory Services

Directory Services endpoint description (placeholder)

List directory services configuration

Displays the role-based access control (RBAC) group configuration settings for manageability.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/directory-services

/api/2.3/directory-services

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "name": "string",
  - "base_dn": "DC=mycompany,DC=com",
  - "bind_password": "****",
  - "bind_user": "CN=John,OU=Users,DC=example,DC=com",
  - "ca_certificate": "string",
  - "check_peer": false,
  - "enabled": true,
  - "services":
    [
    "data",
    "management"
    ],
  - "uris":
    [
    "ldaps://ad1.mycompany.com"
    ],
  - "management":
    {
    "user_login_attribute": "email",
    "user_object_class": "inetOrgPerson"
    }
  }
]

}

Modify directory services configuration

Modifies the directory service configuration.

query Parameters

names

required

Array of strings

Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

base_dn	string Base of the Distinguished Name (DN) of the directory service groups.
bind_password	string Masked password used to query the directory.
bind_user	string Username used to query the directory.
ca_certificate	string <= 3000 characters The certificate of the Certificate Authority (CA) that signed the certificates of the directory servers, which is used to validate the authenticity of the configured servers.
check_peer	boolean Whether or not server authenticity is enforced when a certificate is provided.
enabled	boolean Whether or not the directory service is enabled.
uris	Array of strings <= 30 characters List of URIs for the configured directory servers.
management	object Properties specific to the management service.

Responses

200

patch /api/2.3/directory-services

/api/2.3/directory-services

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"base_dn": "DC=mycompany,DC=com",
"bind_password": "****",
"bind_user": "CN=John,OU=Users,DC=example,DC=com",
"ca_certificate": "string",
"check_peer": false,
"enabled": true,
"uris":
[
- "ldaps://ad1.mycompany.com"
],
"management":
{
- "user_login_attribute": "email",
- "user_object_class": "inetOrgPerson"
}

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "name": "string",
  - "base_dn": "DC=mycompany,DC=com",
  - "bind_password": "****",
  - "bind_user": "CN=John,OU=Users,DC=example,DC=com",
  - "ca_certificate": "string",
  - "check_peer": false,
  - "enabled": true,
  - "services":
    [
    "data",
    "management"
    ],
  - "uris":
    [
    "ldaps://ad1.mycompany.com"
    ],
  - "management":
    {
    "user_login_attribute": "email",
    "user_object_class": "inetOrgPerson"
    }
  }
]

}

List directory services roles

Displays the role-based access control (RBAC) group role settings.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
role_names	Array of strings Performs the operation on the unique roles specified. For example, `array_admin`. Enter multiple roles in comma-separated format.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/directory-services/roles

/api/2.3/directory-services/roles

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "group": "groupOfUsers",
  - "group_base": "OU=PureGroups,OU=SANManagers",
  - "role":
    {
    "name": "string"
    }
  }
]

}

Modify directory services roles

Modifies directory services roles, mapping them to their configured group and group_base in the directory service.

query Parameters

role_names

required

Array of strings

Performs the operation on the unique roles specified. For example, array_admin. Enter multiple roles in comma-separated format.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

group	string Common Name (CN) of the directory service group that contains users with the authority level of the specified role name.
group_base	string Specifies where the configured group is located in the directory tree.

Responses

200

patch /api/2.3/directory-services/roles

/api/2.3/directory-services/roles

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"group": "groupOfUsers",
"group_base": "OU=PureGroups,OU=SANManagers"

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "group": "groupOfUsers",
  - "group_base": "OU=PureGroups,OU=SANManagers",
  - "role":
    {
    "name": "string"
    }
  }
]

}

List directory services test results

Displays the directory services test and displays the results. The test verifies that URIs can be resolved and that the array can bind and query the tree using the bind user credentials. The test also verifies that the array can find all configured groups to ensure the common names and group base are correctly configured.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names required	Array of strings Performs the operation on the unique name specified. For example, `name01`. Enter multiple names in comma-separated format.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/directory-services/test

/api/2.3/directory-services/test

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "component_address": "10.230.94.21",
  - "component_name": "CT0",
  - "description": "Testing phonehome connectivity",
  - "destination": "ra.cloud-support.purestorage.com",
  - "enabled": true,
  - "result_details": "Timeout connecting to phonehome endpoint",
  - "success": true,
  - "test_type": "phonehome",
  - "resource":
    {
    "name": "string"
    }
  }
]

}

Directory Snapshots

Directory Snapshots endpoint description (placeholder)

List directory snapshots

Displays a list of directory snapshots, including those pending eradication.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
source_ids	Array of strings Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.
source_names	Array of strings Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, `name01,name02`.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/directory-snapshots

/api/2.3/directory-snapshots

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "client_name": "string",
  - "created": 0,
  - "destroyed": true,
  - "policy":
    {
    "id": "string",
    "name": "string"
    },
  - "source":
    {
    "id": "string",
    "name": "string"
    },
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "suffix": 0,
  - "time_remaining": 0
  }
],
"total":
[
- {
  - "id": "string",
  - "name": "string",
  - "client_name": "string",
  - "created": 0,
  - "destroyed": true,
  - "policy":
    {
    "id": "string",
    "name": "string"
    },
  - "source":
    {
    "id": "string",
    "name": "string"
    },
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "suffix": 0,
  - "time_remaining": 0
  }
]

}

Create directory snapshot

Creates a snapshot of the contents of a directory. The source_ids or source_names parameter is required, but cannot be set together.

query Parameters

source_ids	Array of strings Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.
source_names	Array of strings Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

client_name	string The customizable portion of the client visible snapshot name. A full snapshot name is constructed in the form of `DIR.CLIENT_NAME.NNN` where `DIR` is the managed directory name, and `NNN` is a monotonically increasing number generated by the system. The client visible snapshot name is `CLIENT_NAME.NNN`.
keep_for	integer <int64> The time to keep the snapshots for, in milliseconds.

Responses

200

post /api/2.3/directory-snapshots

/api/2.3/directory-snapshots

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"client_name": "string",
"keep_for": 0

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "client_name": "string",
  - "created": 0,
  - "destroyed": true,
  - "policy":
    {
    "id": "string",
    "name": "string"
    },
  - "source":
    {
    "id": "string",
    "name": "string"
    },
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "suffix": 0,
  - "time_remaining": 0
  }
]

}

Delete directory snapshot

Deletes a directory snapshot that has been destroyed and is pending eradication. Eradicated directory snapshots cannot be recovered. Directory snapshots are destroyed by using the PATCH method. The ids or names parameter is required, but cannot be set together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/directory-snapshots

/api/2.3/directory-snapshots

Modify directory snapshot

Modifies a directory snapshot. You can destroy, recover, or update the policy or time remaining of a directory snapshot. To destroy a directory snapshot, set destroyed=true. To recover a directory snapshot that has been destroyed and is pending eradication, set destroyed=false. The ids or names parameter is required, but cannot be set together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

destroyed	boolean If set to `true`, destroys a resource. Once set to `true`, the `time_remaining` value will display the amount of time left until the destroyed resource is permanently eradicated. Before the `time_remaining` period has elapsed, the destroyed resource can be recovered by setting `destroyed=false`. Once the `time_remaining` period has elapsed, the resource is permanently eradicated and can no longer be recovered.
keep_for	integer <int64> The amount of time to keep the snapshots, in milliseconds. Can only be set on snapshots that are not managed by any snapshot policy. Set to `""` to clear the keep_for value.
policy	object The snapshot policy that manages this snapshot. Set to `name` or `id` to `""` to clear the policy.

Responses

200

patch /api/2.3/directory-snapshots

/api/2.3/directory-snapshots

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"destroyed": true,
"keep_for": 0,
"policy":
{
- "id": "string",
- "name": "string"
}

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "client_name": "string",
  - "created": 0,
  - "destroyed": true,
  - "policy":
    {
    "id": "string",
    "name": "string"
    },
  - "source":
    {
    "id": "string",
    "name": "string"
    },
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "suffix": 0,
  - "time_remaining": 0
  }
]

}

DNS

DNS endpoint description (placeholder)

List DNS parameters

Displays the current DNS parameters of the array, including domain suffix and name servers.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/dns

/api/2.3/dns

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "domain": "example.com",
  - "nameservers":
    [
    "192.168.0.125"
    ]
  }
]

}

Modify DNS parameters

Modifies the DNS parameters of an array, including the domain suffix and the list of DNS name server IP addresses.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

domain	string Domain suffix to be appended by the appliance when performing DNS lookups.
nameservers	Array of strings <= 3 characters List of DNS server IP addresses.

Responses

200

patch /api/2.3/dns

/api/2.3/dns

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"domain": "example.com",
"nameservers":
[
- "192.168.0.125"
]

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "domain": "example.com",
  - "nameservers":
    [
    "192.168.0.125"
    ]
  }
]

}

File Systems

File Systems endpoint description (placeholder)

List file systems

Displays a list of file systems, including those pending eradication.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/file-systems

/api/2.3/file-systems

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "created": 0,
  - "destroyed": true,
  - "time_remaining": 0
  }
]

}

Create file system

Creates one or more file systems.

query Parameters

names

required

Array of strings

Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

post /api/2.3/file-systems

/api/2.3/file-systems

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "created": 0,
  - "destroyed": true,
  - "time_remaining": 0
  }
]

}

Modify a file system

Modifies a file system. You can rename, destroy, or recover a file system. To rename a file system, set name to the new name. To destroy a file system, set destroyed=true. To recover a file system that has been destroyed and is pending eradication, set destroyed=false.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

destroyed

boolean

If set to true, destroys a resource. Once set to true, the time_remaining value will display the amount of time left until the destroyed resource is permanently eradicated. Before the time_remaining period has elapsed, the destroyed resource can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the resource is permanently eradicated and can no longer be recovered.

name

string

The new name for the resource.

Responses

200

patch /api/2.3/file-systems

/api/2.3/file-systems

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"destroyed": true,
"name": "string"

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "created": 0,
  - "destroyed": true,
  - "time_remaining": 0
  }
]

}

Delete file system

Deletes a file system that has been destroyed and is pending eradication. Eradicated file systems cannot be recovered. File systems are destroyed using the PATCH method.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/file-systems

/api/2.3/file-systems

Hardware

Hardware endpoint description (placeholder)

List hardware component information

Displays a list of hardware slots and bays and status of installed components.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/hardware

/api/2.3/hardware

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "name": "string",
  - "details": "Temperature too high",
  - "identify_enabled": true,
  - "index": 1,
  - "model": "DFSC1",
  - "serial": "PSMFL1717009B",
  - "slot": 16,
  - "speed": 24000000000,
  - "status": "critical",
  - "temperature": 25,
  - "type": "ct",
  - "voltage": 206
  }
]

}

Modify visual identification

Modifies the visual identification of a specified hardware component, and causing the ID LED to turn on or off.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

identify_enabled	boolean State of an LED used to visually identify the component.
index	integer <int32> Number that identifies the relative position of a hardware component within the array.

Responses

200

patch /api/2.3/hardware

/api/2.3/hardware

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"identify_enabled": true,
"index": 1

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "name": "string",
  - "details": "Temperature too high",
  - "identify_enabled": true,
  - "index": 1,
  - "model": "DFSC1",
  - "serial": "PSMFL1717009B",
  - "slot": 16,
  - "speed": 24000000000,
  - "status": "critical",
  - "temperature": 25,
  - "type": "ct",
  - "voltage": 206
  }
]

}

Host Groups

Host groups implement consistent connections between a set of hosts and one or more volumes. Connections are consistent in the sense that all hosts associated with a host group address a volume connected to the group by the same LUN. Host groups are typically used to provide a common view of storage volumes to the hosts in a clustered application.

List host groups

Returns a list of host groups.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/host-groups

/api/2.3/host-groups

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "name": "string",
  - "connection_count": 3,
  - "host_count": 3,
  - "is_local": true,
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    }
  }
]

}

Create a host group

Creates a host group. The names query parameter is required.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

post /api/2.3/host-groups

/api/2.3/host-groups

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "name": "string",
  - "connection_count": 3,
  - "host_count": 3,
  - "is_local": true,
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    }
  }
]

}

Delete a host group

Deletes a host group. The names query parameter is required.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/host-groups

/api/2.3/host-groups

Manage a host group

Manages a host group. The names query parameter is required.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

name	string The new name for the resource.

Responses

200

patch /api/2.3/host-groups

/api/2.3/host-groups

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"name": "string"

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "name": "string",
  - "connection_count": 3,
  - "host_count": 3,
  - "is_local": true,
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    }
  }
]

}

List host groups that are associated with hosts

Returns a list of host groups that are associated with hosts.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/host-groups/hosts

/api/2.3/host-groups/hosts

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "group":
    {
    "name": "string"
    },
  - "member":
    {
    "name": "string"
    }
  }
]

}

Add a host to a host group

Adds a host to a host group. Adding a host to a host group automatically connects the host to all volumes associated with the group. Multiple hosts can be belong to a host group, but a host can only belong to one host group. Hosts can be added to host groups at any time. The group_names and member_names parameters are required and must be set together, and only one host group can be specified at a time.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

post /api/2.3/host-groups/hosts

/api/2.3/host-groups/hosts

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "group":
    {
    "name": "string"
    },
  - "member":
    {
    "name": "string"
    }
  }
]

}

Remove a host from a host group

Removes a host from a host group. Removing a host from a host group automatically disconnects the host from all volumes associated with the group. Hosts can be removed from host groups at any time. The group_names and member_names parameters are required and must be set together, and only one host group can be specified at a time.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/host-groups/hosts

/api/2.3/host-groups/hosts

List host group performance data

Returns real-time and historical performance data, real-time latency data, and average I/O sizes across all volumes, displayed both by host group and as a total across all host groups.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/host-groups/performance

/api/2.3/host-groups/performance

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "name": "string",
  - "bytes_per_mirrored_write": 0,
  - "bytes_per_op": 0,
  - "bytes_per_read": 0,
  - "bytes_per_write": 0,
  - "mirrored_write_bytes_per_sec": 0,
  - "mirrored_writes_per_sec": 0,
  - "qos_rate_limit_usec_per_mirrored_write_op": 0,
  - "qos_rate_limit_usec_per_read_op": 0,
  - "qos_rate_limit_usec_per_write_op": 0,
  - "queue_usec_per_mirrored_write_op": 0,
  - "queue_usec_per_read_op": 0,
  - "queue_usec_per_write_op": 0,
  - "read_bytes_per_sec": 0,
  - "reads_per_sec": 0,
  - "san_usec_per_mirrored_write_op": 0,
  - "san_usec_per_read_op": 0,
  - "san_usec_per_write_op": 0,
  - "service_usec_per_mirrored_write_op": 0,
  - "service_usec_per_read_op": 0,
  - "service_usec_per_write_op": 0,
  - "time": 0,
  - "usec_per_mirrored_write_op": 0,
  - "usec_per_read_op": 0,
  - "usec_per_write_op": 0,
  - "write_bytes_per_sec": 0,
  - "writes_per_sec": 0
  }
],
"total":
[
- {
  - "name": "string",
  - "bytes_per_mirrored_write": 0,
  - "bytes_per_op": 0,
  - "bytes_per_read": 0,
  - "bytes_per_write": 0,
  - "mirrored_write_bytes_per_sec": 0,
  - "mirrored_writes_per_sec": 0,
  - "qos_rate_limit_usec_per_mirrored_write_op": 0,
  - "qos_rate_limit_usec_per_read_op": 0,
  - "qos_rate_limit_usec_per_write_op": 0,
  - "queue_usec_per_mirrored_write_op": 0,
  - "queue_usec_per_read_op": 0,
  - "queue_usec_per_write_op": 0,
  - "read_bytes_per_sec": 0,
  - "reads_per_sec": 0,
  - "san_usec_per_mirrored_write_op": 0,
  - "san_usec_per_read_op": 0,
  - "san_usec_per_write_op": 0,
  - "service_usec_per_mirrored_write_op": 0,
  - "service_usec_per_read_op": 0,
  - "service_usec_per_write_op": 0,
  - "time": 0,
  - "usec_per_mirrored_write_op": 0,
  - "usec_per_read_op": 0,
  - "usec_per_write_op": 0,
  - "write_bytes_per_sec": 0,
  - "writes_per_sec": 0
  }
]

}

List host group performance data by array

Returns real-time and historical performance data, real-time latency data, and average I/O size data. The data returned is for each volume that is connected to a host group on the current array and for each volume that is connected to a host group on any remote arrays that are visible to the current array. The data is displayed as a total across all host groups on each array and by individual host group.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/host-groups/performance/by-array

/api/2.3/host-groups/performance/by-array

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "name": "string",
  - "bytes_per_mirrored_write": 0,
  - "bytes_per_op": 0,
  - "bytes_per_read": 0,
  - "bytes_per_write": 0,
  - "mirrored_write_bytes_per_sec": 0,
  - "mirrored_writes_per_sec": 0,
  - "qos_rate_limit_usec_per_mirrored_write_op": 0,
  - "qos_rate_limit_usec_per_read_op": 0,
  - "qos_rate_limit_usec_per_write_op": 0,
  - "queue_usec_per_mirrored_write_op": 0,
  - "queue_usec_per_read_op": 0,
  - "queue_usec_per_write_op": 0,
  - "read_bytes_per_sec": 0,
  - "reads_per_sec": 0,
  - "san_usec_per_mirrored_write_op": 0,
  - "san_usec_per_read_op": 0,
  - "san_usec_per_write_op": 0,
  - "service_usec_per_mirrored_write_op": 0,
  - "service_usec_per_read_op": 0,
  - "service_usec_per_write_op": 0,
  - "time": 0,
  - "usec_per_mirrored_write_op": 0,
  - "usec_per_read_op": 0,
  - "usec_per_write_op": 0,
  - "write_bytes_per_sec": 0,
  - "writes_per_sec": 0,
  - "array":
    {
    "id": "string",
    "name": "string"
    }
  }
],
"total":
[
- {
  - "name": "string",
  - "bytes_per_mirrored_write": 0,
  - "bytes_per_op": 0,
  - "bytes_per_read": 0,
  - "bytes_per_write": 0,
  - "mirrored_write_bytes_per_sec": 0,
  - "mirrored_writes_per_sec": 0,
  - "qos_rate_limit_usec_per_mirrored_write_op": 0,
  - "qos_rate_limit_usec_per_read_op": 0,
  - "qos_rate_limit_usec_per_write_op": 0,
  - "queue_usec_per_mirrored_write_op": 0,
  - "queue_usec_per_read_op": 0,
  - "queue_usec_per_write_op": 0,
  - "read_bytes_per_sec": 0,
  - "reads_per_sec": 0,
  - "san_usec_per_mirrored_write_op": 0,
  - "san_usec_per_read_op": 0,
  - "san_usec_per_write_op": 0,
  - "service_usec_per_mirrored_write_op": 0,
  - "service_usec_per_read_op": 0,
  - "service_usec_per_write_op": 0,
  - "time": 0,
  - "usec_per_mirrored_write_op": 0,
  - "usec_per_read_op": 0,
  - "usec_per_write_op": 0,
  - "write_bytes_per_sec": 0,
  - "writes_per_sec": 0,
  - "array":
    {
    "id": "string",
    "name": "string"
    }
  }
]

}

List host groups that are members of protection groups

Displays a list of host group members that belong to one or more protection groups.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/host-groups/protection-groups

/api/2.3/host-groups/protection-groups

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "group":
    {
    "name": "string"
    },
  - "member":
    {
    "name": "string"
    }
  }
]

}

Create a host group

Creates a host group member and assigns to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host group. The group_names and member_names parameters are required and must be set together.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

post /api/2.3/host-groups/protection-groups

/api/2.3/host-groups/protection-groups

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "group":
    {
    "name": "string"
    },
  - "member":
    {
    "name": "string"
    }
  }
]

}

Delete a host group from a protection group

Deletes a host group member from a protection group. After the member has been removed, it is no longer protected by the group. Any protection group snapshots that were taken before the member was removed are not affected. Removing a member from a protection group does not delete the member from the array, and the member can be added back to the protection group at any time. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host group. The group_names and member_names parameters are required and must be set together.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/host-groups/protection-groups

/api/2.3/host-groups/protection-groups

List host group space information

Returns provisioned (virtual) size and physical storage consumption data for each host group.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/host-groups/space

/api/2.3/host-groups/space

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "name": "string",
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "time": 0
  }
]

}

Hosts

Hosts organize the storage network addresses (iSCSI Qualified Names, NVMe qualified names, or Fibre Channel world wide names) of client computers to identify the host's intiators. Hosts also control communications between clients and volumes. After a volume has been created, establish a host-volume connection so that the host can read data from and write data to the volume.

List hosts

Returns a list of hosts.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/hosts

/api/2.3/hosts

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "name": "string",
  - "chap":
    {
    "host_password": "string",
    "host_user": "string",
    "target_password": "string",
    "target_user": "string"
    },
  - "connection_count": 3,
  - "host_group":
    {
    "name": "string"
    },
  - "iqns":
    [
    "iqn.2010-06.com.purestorage:linux.393d930077be2977"
    ],
  - "nqns":
    [
    "nqn.2010-06.com.purestorage:flasharray.512f7bb185978505"
    ],
  - "personality": "string",
  - "port_connectivity":
    {
    "details": "Redundant",
    "status": "healthy"
    },
  - "preferred_arrays":
    [
    {
    "id": "string",
    "name": "string"
    }
    ],
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "wwns":
    [
    "52:4A:93:70:4E:E5:68:00"
    ],
  - "is_local": true
  }
]

}

Create a host

Creates a host. The names query parameter is required.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

chap	object Challenge-Handshake Authentication Protocol (CHAP).
iqns	Array of strings The iSCSI qualified name (IQN) associated with the host.
nqns	Array of strings The NVMe Qualified Name (NQN) associated with the host.
personality	string Determines how the system tunes the array to ensure that it works optimally with the host. Set `personality` to the name of the host operating system or virtual memory system. Valid values are `aix`, `esxi`, `hitachi-vsp`, `hpux`, `oracle-vm-server`, `solaris`, and `vms`. If your system is not listed as one of the valid host personalities, do not set the option. By default, the personality is not set.
preferred_arrays	Array of objects For synchronous replication configurations, sets a host's preferred array to specify which array exposes active/optimized paths to that host. Enter multiple preferred arrays in comma-separated format. If a preferred array is set for a host, then the other arrays in the same pod will expose active/non-optimized paths to that host. If the host is in a host group, `preferred_arrays` cannot be set because host groups have their own preferred arrays. On a preferred array of a certain host, all the paths on all the ports (for both the primary and secondary controllers) are set up as A/O (active/optimized) paths, while on a non-preferred array, all the paths are A/N (Active/Non-optimized) paths.
wwns	Array of strings The Fibre Channel World Wide Name (WWN) associated with the host.

Responses

200

post /api/2.3/hosts

/api/2.3/hosts

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"chap":
{
- "host_password": "string",
- "host_user": "string",
- "target_password": "string",
- "target_user": "string"
},
"iqns":
[
- "iqn.2010-06.com.purestorage:linux.393d930077be2977"
],
"nqns":
[
- "nqn.2010-06.com.purestorage:flasharray.512f7bb185978505"
],
"personality": "string",
"preferred_arrays":
[
- {
  - "id": "string",
  - "name": "string"
  }
],
"wwns":
[
- "52:4A:93:70:4E:E5:68:00"
]

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "name": "string",
  - "chap":
    {
    "host_password": "string",
    "host_user": "string",
    "target_password": "string",
    "target_user": "string"
    },
  - "connection_count": 3,
  - "host_group":
    {
    "name": "string"
    },
  - "iqns":
    [
    "iqn.2010-06.com.purestorage:linux.393d930077be2977"
    ],
  - "nqns":
    [
    "nqn.2010-06.com.purestorage:flasharray.512f7bb185978505"
    ],
  - "personality": "string",
  - "port_connectivity":
    {
    "details": "Redundant",
    "status": "healthy"
    },
  - "preferred_arrays":
    [
    {
    "id": "string",
    "name": "string"
    }
    ],
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "wwns":
    [
    "52:4A:93:70:4E:E5:68:00"
    ],
  - "is_local": true
  }
]

}

Delete a host

Deletes an existing host. All volumes that are connected to the host, either through private or shared connections, must be disconnected from the host before the host can be deleted. The names query parameter is required.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/hosts

/api/2.3/hosts

Manage a host

Manages an existing host, including its storage network addresses, CHAP, host personality, and preferred arrays, or associate a host to a host group. The names query parameter is required.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

name	string The new name for the resource.
add_iqns	Array of strings Adds the specified iSCSI Qualified Names (IQNs) to those already associated with the specified host.
add_nqns	Array of strings Adds the specified NVMe Qualified Names (NQNs) to those already associated with the specified host.
add_wwns	Array of strings Adds the specified Fibre Channel World Wide Names (WWNs) to those already associated with the specified host.
chap	object Challenge-Handshake Authentication Protocol (CHAP).
host_group	object The host group to which the host should be associated.
iqns	Array of strings The iSCSI qualified name (IQN) associated with the host.
nqns	Array of strings The NVMe Qualified Name (NQN) associated with the host.
personality	string Determines how the system tunes the array to ensure that it works optimally with the host. Set `personality` to the name of the host operating system or virtual memory system. Valid values are `aix`, `esxi`, `hitachi-vsp`, `hpux`, `oracle-vm-server`, `solaris`, and `vms`. If your system is not listed as one of the valid host personalities, do not set the option. By default, the personality is not set.
preferred_arrays	Array of objects For synchronous replication configurations, sets a host's preferred array to specify which array exposes active/optimized paths to that host. Enter multiple preferred arrays in comma-separated format. If a preferred array is set for a host, then the other arrays in the same pod will expose active/non-optimized paths to that host. If the host is in a host group, `preferred_arrays` cannot be set because host groups have their own preferred arrays. On a preferred array of a certain host, all the paths on all the ports (for both the primary and secondary controllers) are set up as A/O (active/optimized) paths, while on a non-preferred array, all the paths are A/N (Active/Non-optimized) paths.
remove_iqns	Array of strings Disassociates the specified iSCSI Qualified Names (IQNs) from the specified host.
remove_nqns	Array of strings Disassociates the specified NVMe Qualified Names (NQNs) from the specified host.
remove_wwns	Array of strings Disassociates the specified Fibre Channel World Wide Names (WWNs) from the specified host.
wwns	Array of strings The Fibre Channel World Wide Name (WWN) associated with the host.

Responses

200

patch /api/2.3/hosts

/api/2.3/hosts

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"name": "string",
"add_iqns":
[
- "iqn.2010-06.com.purestorage:linux.393d930077be2977"
],
"add_nqns":
[
- "nqn.2010-06.com.purestorage:flasharray.512f7bb185978505"
],
"add_wwns":
[
- "52:4A:93:70:4E:E5:68:00"
],
"chap":
{
- "host_password": "string",
- "host_user": "string",
- "target_password": "string",
- "target_user": "string"
},
"host_group":
{
- "name": "string"
},
"iqns":
[
- "iqn.2010-06.com.purestorage:linux.393d930077be2977"
],
"nqns":
[
- "nqn.2010-06.com.purestorage:flasharray.512f7bb185978505"
],
"personality": "string",
"preferred_arrays":
[
- {
  - "id": "string",
  - "name": "string"
  }
],
"remove_iqns":
[
- "iqn.2010-06.com.purestorage:linux.393d930077be2977"
],
"remove_nqns":
[
- "nqn.2010-06.com.purestorage:flasharray.512f7bb185978505"
],
"remove_wwns":
[
- "52:4A:93:70:4E:E5:68:00"
],
"wwns":
[
- "52:4A:93:70:4E:E5:68:00"
]

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "name": "string",
  - "chap":
    {
    "host_password": "string",
    "host_user": "string",
    "target_password": "string",
    "target_user": "string"
    },
  - "connection_count": 3,
  - "host_group":
    {
    "name": "string"
    },
  - "iqns":
    [
    "iqn.2010-06.com.purestorage:linux.393d930077be2977"
    ],
  - "nqns":
    [
    "nqn.2010-06.com.purestorage:flasharray.512f7bb185978505"
    ],
  - "personality": "string",
  - "port_connectivity":
    {
    "details": "Redundant",
    "status": "healthy"
    },
  - "preferred_arrays":
    [
    {
    "id": "string",
    "name": "string"
    }
    ],
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "wwns":
    [
    "52:4A:93:70:4E:E5:68:00"
    ],
  - "is_local": true
  }
]

}

List hosts that are associated with host groups

Returns a list of hosts that are associated with host groups.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/hosts/host-groups

/api/2.3/hosts/host-groups

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "group":
    {
    "name": "string"
    },
  - "member":
    {
    "name": "string"
    }
  }
]

}

Add a host to a host group

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

post /api/2.3/hosts/host-groups

/api/2.3/hosts/host-groups

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "group":
    {
    "name": "string"
    },
  - "member":
    {
    "name": "string"
    }
  }
]

}

Remove a host from a host group

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/hosts/host-groups

/api/2.3/hosts/host-groups

List host performance data

Returns real-time and historical performance data, real-time latency data, and average I/O sizes across all volumes, displayed both by host and as a total across all hosts.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/hosts/performance

/api/2.3/hosts/performance

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "name": "string",
  - "bytes_per_mirrored_write": 0,
  - "bytes_per_op": 0,
  - "bytes_per_read": 0,
  - "bytes_per_write": 0,
  - "mirrored_write_bytes_per_sec": 0,
  - "mirrored_writes_per_sec": 0,
  - "qos_rate_limit_usec_per_mirrored_write_op": 0,
  - "qos_rate_limit_usec_per_read_op": 0,
  - "qos_rate_limit_usec_per_write_op": 0,
  - "queue_usec_per_mirrored_write_op": 0,
  - "queue_usec_per_read_op": 0,
  - "queue_usec_per_write_op": 0,
  - "read_bytes_per_sec": 0,
  - "reads_per_sec": 0,
  - "san_usec_per_mirrored_write_op": 0,
  - "san_usec_per_read_op": 0,
  - "san_usec_per_write_op": 0,
  - "service_usec_per_mirrored_write_op": 0,
  - "service_usec_per_read_op": 0,
  - "service_usec_per_write_op": 0,
  - "time": 0,
  - "usec_per_mirrored_write_op": 0,
  - "usec_per_read_op": 0,
  - "usec_per_write_op": 0,
  - "write_bytes_per_sec": 0,
  - "writes_per_sec": 0
  }
],
"total":
[
- {
  - "name": "string",
  - "bytes_per_mirrored_write": 0,
  - "bytes_per_op": 0,
  - "bytes_per_read": 0,
  - "bytes_per_write": 0,
  - "mirrored_write_bytes_per_sec": 0,
  - "mirrored_writes_per_sec": 0,
  - "qos_rate_limit_usec_per_mirrored_write_op": 0,
  - "qos_rate_limit_usec_per_read_op": 0,
  - "qos_rate_limit_usec_per_write_op": 0,
  - "queue_usec_per_mirrored_write_op": 0,
  - "queue_usec_per_read_op": 0,
  - "queue_usec_per_write_op": 0,
  - "read_bytes_per_sec": 0,
  - "reads_per_sec": 0,
  - "san_usec_per_mirrored_write_op": 0,
  - "san_usec_per_read_op": 0,
  - "san_usec_per_write_op": 0,
  - "service_usec_per_mirrored_write_op": 0,
  - "service_usec_per_read_op": 0,
  - "service_usec_per_write_op": 0,
  - "time": 0,
  - "usec_per_mirrored_write_op": 0,
  - "usec_per_read_op": 0,
  - "usec_per_write_op": 0,
  - "write_bytes_per_sec": 0,
  - "writes_per_sec": 0
  }
]

}

List host performance data by array

Returns real-time and historical performance data, real-time latency data, and average I/O size data. The data returned is for each volume that is connected to a host on the current array and for each volume that is connected to a host on any remote arrays that are visible to the current array. The data is displayed as a total across all hosts on each array and by individual host.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/hosts/performance/by-array

/api/2.3/hosts/performance/by-array

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "name": "string",
  - "bytes_per_mirrored_write": 0,
  - "bytes_per_op": 0,
  - "bytes_per_read": 0,
  - "bytes_per_write": 0,
  - "mirrored_write_bytes_per_sec": 0,
  - "mirrored_writes_per_sec": 0,
  - "qos_rate_limit_usec_per_mirrored_write_op": 0,
  - "qos_rate_limit_usec_per_read_op": 0,
  - "qos_rate_limit_usec_per_write_op": 0,
  - "queue_usec_per_mirrored_write_op": 0,
  - "queue_usec_per_read_op": 0,
  - "queue_usec_per_write_op": 0,
  - "read_bytes_per_sec": 0,
  - "reads_per_sec": 0,
  - "san_usec_per_mirrored_write_op": 0,
  - "san_usec_per_read_op": 0,
  - "san_usec_per_write_op": 0,
  - "service_usec_per_mirrored_write_op": 0,
  - "service_usec_per_read_op": 0,
  - "service_usec_per_write_op": 0,
  - "time": 0,
  - "usec_per_mirrored_write_op": 0,
  - "usec_per_read_op": 0,
  - "usec_per_write_op": 0,
  - "write_bytes_per_sec": 0,
  - "writes_per_sec": 0,
  - "array":
    {
    "id": "string",
    "name": "string"
    }
  }
],
"total":
[
- {
  - "name": "string",
  - "bytes_per_mirrored_write": 0,
  - "bytes_per_op": 0,
  - "bytes_per_read": 0,
  - "bytes_per_write": 0,
  - "mirrored_write_bytes_per_sec": 0,
  - "mirrored_writes_per_sec": 0,
  - "qos_rate_limit_usec_per_mirrored_write_op": 0,
  - "qos_rate_limit_usec_per_read_op": 0,
  - "qos_rate_limit_usec_per_write_op": 0,
  - "queue_usec_per_mirrored_write_op": 0,
  - "queue_usec_per_read_op": 0,
  - "queue_usec_per_write_op": 0,
  - "read_bytes_per_sec": 0,
  - "reads_per_sec": 0,
  - "san_usec_per_mirrored_write_op": 0,
  - "san_usec_per_read_op": 0,
  - "san_usec_per_write_op": 0,
  - "service_usec_per_mirrored_write_op": 0,
  - "service_usec_per_read_op": 0,
  - "service_usec_per_write_op": 0,
  - "time": 0,
  - "usec_per_mirrored_write_op": 0,
  - "usec_per_read_op": 0,
  - "usec_per_write_op": 0,
  - "write_bytes_per_sec": 0,
  - "writes_per_sec": 0,
  - "array":
    {
    "id": "string",
    "name": "string"
    }
  }
]

}

List hosts that are members of protection groups

Displays a list of host members that belong to one or more protection groups.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/hosts/protection-groups

/api/2.3/hosts/protection-groups

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "group":
    {
    "name": "string"
    },
  - "member":
    {
    "name": "string"
    }
  }
]

}

Create a host

Creates a host member and adds it to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host. The group_names and member_names parameters are required and must be set together.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

post /api/2.3/hosts/protection-groups

/api/2.3/hosts/protection-groups

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "group":
    {
    "name": "string"
    },
  - "member":
    {
    "name": "string"
    }
  }
]

}

Delete a host from a protection group

Deletes a host member from a protection group. After the member has been removed, it is no longer protected by the group. Any protection group snapshots that were taken before the member was removed are not affected. Removing a member from a protection group does not delete the member from the array, and the member can be added back to the protection group at any time. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host. The group_names and member_names parameters are required and must be set together.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/hosts/protection-groups

/api/2.3/hosts/protection-groups

List host space information

Returns provisioned (virtual) size and physical storage consumption data for each host.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/hosts/space

/api/2.3/hosts/space

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "name": "string",
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "time": 0
  }
]

}

KMIP

KMIP endpoint description (placeholder)

List KMIP server objects

Displays the list of KMIP server objects.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/kmip

/api/2.3/kmip

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "name": "string",
  - "ca_certificate": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
  - "certificate":
    {
    "name": "string"
    },
  - "uris":
    [
    "1.1.1.1:8888",
    "2.2.2.2:9999"
    ]
  }
]

}

Create KMIP server object

Creates KMIP server objects.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

ca_certificate	string <= 3000 characters The text of the CA certificate for the KMIP server.
certificate	object The certificate used to verify FlashArray authenticity to the KMIP servers.
uris	Array of strings List of URIs for the configured KMIP servers.

Responses

200

Returns the newly created KMIP server object.

post /api/2.3/kmip

/api/2.3/kmip

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"ca_certificate": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
"certificate":
{
- "name": "string"
},
"uris":
[
- "1.1.1.1:8888",
- "2.2.2.2:9999"
]

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "name": "string",
  - "ca_certificate": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
  - "certificate":
    {
    "name": "string"
    },
  - "uris":
    [
    "1.1.1.1:8888",
    "2.2.2.2:9999"
    ]
  }
]

}

Delete KMIP server object

Deletes KMIP server objects.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/kmip

/api/2.3/kmip

Modify KMIP attributes

Modifies one or more attributes of KMIP server objects.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

ca_certificate	string <= 3000 characters The text of the CA certificate for the KMIP server.
certificate	object The certificate used to verify FlashArray authenticity to the KMIP servers.
uris	Array of strings List of URIs for the configured KMIP servers.

Responses

200

patch /api/2.3/kmip

/api/2.3/kmip

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"ca_certificate": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
"certificate":
{
- "name": "string"
},
"uris":
[
- "1.1.1.1:8888",
- "2.2.2.2:9999"
]

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "name": "string",
  - "ca_certificate": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
  - "certificate":
    {
    "name": "string"
    },
  - "uris":
    [
    "1.1.1.1:8888",
    "2.2.2.2:9999"
    ]
  }
]

}

Lists KMIP connection tests

Displays communication data between a FlashArray and KMIP server.

query Parameters

names

required

Array of strings

Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/kmip/test

/api/2.3/kmip/test

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "component_address": "10.230.94.21",
  - "component_name": "kmip-test1",
  - "description": "Testing kmip connectivity.",
  - "destination": "kmip-test-server.dev.purestorage.com",
  - "enabled": true,
  - "result_details": "KMIP test failed",
  - "success": true,
  - "test_type": "kmip"
  }
]

}

Maintenance Windows

Maintenance Windows endpoint description (placeholder)

List maintenance window details

Displays maintenance window details, including start time, end time, and maintenance type.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/maintenance-windows

/api/2.3/maintenance-windows

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "name": "string",
  - "created": 0,
  - "expires": 0
  }
]

}

Create a maintenance window

Creates a maintenance window that suppresses alerts for a specified period of time. A maintenance window can be manually closed at any time. The names and timeout parameters are required. Set the names parameter to environment.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

timeout

integer <int32>

The specified length of time that alerts are suppressed during a maintenance window, measured in milliseconds. The maintenance window timeout value must be between 60000 (1 minute) and 86400000 (24 hours). The value entered is rounded down to the nearest minute. The names and timeout parameters must be set together, and the names parameter must be set to environment.

Responses

200

post /api/2.3/maintenance-windows

/api/2.3/maintenance-windows

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"timeout": 3600000

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "name": "string",
  - "created": 0,
  - "expires": 0
  }
]

}

Delete maintenance window

Deletes an open maintenance window before its scheduled end (expire) time. The names parameter is required and must be set to environment.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/maintenance-windows

/api/2.3/maintenance-windows

Offloads

The offload feature enables system administrators to replicate point-in-time volume snapshots from the array to an external storage system for long-term retention. Each offload target represents an external storage system, such as an Azure Blob container, NFS device, or S3 bucket, to where Purity//FA volume snapshots can be replicated.

List offload targets

Displays a list of offload targets that are connected to the array.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
protocol	string Protocol type. Valid values are `azure`, `google-cloud`, `nfs`, and `s3`.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/offloads

/api/2.3/offloads

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "azure":
    {
    "container_name": "string",
    "account_name": "string",
    "secret_access_key": "string"
    },
  - "google-cloud":
    {
    "access_key_id": "string",
    "bucket": "string",
    "secret_access_key": "string"
    },
  - "nfs":
    {
    "address": "string",
    "mount_options": "string",
    "mount_point": "string"
    },
  - "s3":
    {
    "access_key_id": "string",
    "bucket": "string",
    "placement_strategy": "string",
    "secret_access_key": "string",
    "uri": "string"
    },
  - "name": "string",
  - "protocol": "string",
  - "target_id": "string",
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "status": "string"
  }
],
"total":
[
- {
  - "azure":
    {
    "container_name": "string",
    "account_name": "string",
    "secret_access_key": "string"
    },
  - "google-cloud":
    {
    "access_key_id": "string",
    "bucket": "string",
    "secret_access_key": "string"
    },
  - "nfs":
    {
    "address": "string",
    "mount_options": "string",
    "mount_point": "string"
    },
  - "s3":
    {
    "access_key_id": "string",
    "bucket": "string",
    "placement_strategy": "string",
    "secret_access_key": "string",
    "uri": "string"
    },
  - "name": "string",
  - "protocol": "string",
  - "target_id": "string",
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "status": "string"
  }
]

}

Create offload target

Creates an offload target, connecting it to an array. Before you can connect to, manage, and replicate to an offload target, the Purity Run app must be installed. For more information about Purity//FA apps, see the Apps section of this guide.

query Parameters

initialize	boolean If set to `true`, initializes the Amazon S3/Azure Blob container/Google Cloud Storage in preparation for offloading. The parameter must be set to `true` if this is the first time the array is connecting to the offload target.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

azure	object Microsoft Azure Blob storage settings.
google-cloud	object Google Cloud Storage settings.
nfs	object NFS settings.
s3	object S3 settings.

Responses

200

post /api/2.3/offloads

/api/2.3/offloads

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"azure":
{
- "container_name": "string",
- "account_name": "string",
- "secret_access_key": "string"
},
"google-cloud":
{
- "access_key_id": "string",
- "bucket": "string",
- "secret_access_key": "string"
},
"nfs":
{
- "address": "string",
- "mount_options": "string",
- "mount_point": "string"
},
"s3":
{
- "access_key_id": "string",
- "bucket": "string",
- "placement_strategy": "string",
- "secret_access_key": "string",
- "uri": "string"
}

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "azure":
    {
    "container_name": "string",
    "account_name": "string",
    "secret_access_key": "string"
    },
  - "google-cloud":
    {
    "access_key_id": "string",
    "bucket": "string",
    "secret_access_key": "string"
    },
  - "nfs":
    {
    "address": "string",
    "mount_options": "string",
    "mount_point": "string"
    },
  - "s3":
    {
    "access_key_id": "string",
    "bucket": "string",
    "placement_strategy": "string",
    "secret_access_key": "string",
    "uri": "string"
    },
  - "name": "string",
  - "protocol": "string",
  - "target_id": "string",
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "status": "string"
  }
]

}

Delete offload target

Deletes an offload target.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/offloads

/api/2.3/offloads

Pods

Synchronous replication is managed through pods. A pod representing a collection of protection groups and volumes is created on one array and stretched to another array, resulting in fully synchronized writes between the two arrays. A pod can contain a mix of volumes, and protection groups with member volumes. Writes to the pod coming into either array are immediately synchronized and seen on both arrays.

List pods

Displays a list of pods that are stretched to this array.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

Responses

200

get /api/2.3/pods

/api/2.3/pods

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "arrays":
    [
    {
    "id": "string",
    "name": "string",
    "frozen_at": 1492662000,
    "mediator_status": "string",
    "pre_elected": true,
    "progress": 0.66,
    "status": "resyncing"
    }
    ],
  - "destroyed": true,
  - "failover_preferences":
    [
    {
    "id": "string",
    "name": "string"
    }
    ],
  - "footprint": 0,
  - "mediator": "https://mediator.cloud-support.purestorage.com",
  - "mediator_version": "1.0.0",
  - "source":
    {
    "id": "string",
    "name": "string"
    },
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0,
    "replication": 0
    },
  - "time_remaining": 0,
  - "requested_promotion_state": "string",
  - "promotion_status": "string",
  - "link_source_count": 1,
  - "link_target_count": 1,
  - "array_count": 1
  }
],
"total":
[
- {
  - "id": "string",
  - "name": "string",
  - "arrays":
    [
    {
    "id": "string",
    "name": "string",
    "frozen_at": 1492662000,
    "mediator_status": "string",
    "pre_elected": true,
    "progress": 0.66,
    "status": "resyncing"
    }
    ],
  - "destroyed": true,
  - "failover_preferences":
    [
    {
    "id": "string",
    "name": "string"
    }
    ],
  - "footprint": 0,
  - "mediator": "https://mediator.cloud-support.purestorage.com",
  - "mediator_version": "1.0.0",
  - "source":
    {
    "id": "string",
    "name": "string"
    },
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0,
    "replication": 0
    },
  - "time_remaining": 0,
  - "requested_promotion_state": "string",
  - "promotion_status": "string",
  - "link_source_count": 1,
  - "link_target_count": 1,
  - "array_count": 1
  }
]

}

Create a pod

Creates a pod on the local array. Each pod must be given a name that is unique across the arrays to which they are stretched, so a pod cannot be stretched to an array that already contains a pod with the same name. After a pod has been created, add volumes and protection groups to the pod, and then stretch the pod to another (connected) array.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

Request Body schema: application/json

failover_preferences

Array of objects

Determines which array within a stretched pod should be given priority to stay online should the arrays ever lose contact with each other. The current array and any peer arrays that are connected to the current array for synchronous replication can be added to a pod for failover preference. By default, failover_preferences=null, meaning no arrays have been configured for failover preference. Enter multiple arrays in comma-separated format. To clear the list of failover preferences, set to an empty list [].

source

object

The source pod from where data is cloned to create the new pod.

Responses

200

post /api/2.3/pods

/api/2.3/pods

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"failover_preferences":
[
- {
  - "id": "string",
  - "name": "string"
  }
],
"source":
{
- "id": "string",
- "name": "string"
}

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "arrays":
    [
    {
    "id": "string",
    "name": "string",
    "frozen_at": 1492662000,
    "mediator_status": "string",
    "pre_elected": true,
    "progress": 0.66,
    "status": "resyncing"
    }
    ],
  - "destroyed": true,
  - "failover_preferences":
    [
    {
    "id": "string",
    "name": "string"
    }
    ],
  - "footprint": 0,
  - "mediator": "https://mediator.cloud-support.purestorage.com",
  - "mediator_version": "1.0.0",
  - "source":
    {
    "id": "string",
    "name": "string"
    },
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0,
    "replication": 0
    },
  - "time_remaining": 0,
  - "requested_promotion_state": "string",
  - "promotion_status": "string",
  - "link_source_count": 1,
  - "link_target_count": 1,
  - "array_count": 1
  }
]

}

Delete a pod

Deletes a pod that has been destroyed and is pending eradication. Eradicated pods cannot be recovered. Pods are destroyed using the PATCH method. The ids or names parameter is required, but cannot be set together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
eradicate_contents	boolean Set to `true` to eradicate contents (e.g., volumes, protection groups, snapshots) and containers (e.g., pods, volume groups). This enables you to eradicate containers with contents.

Responses

200

delete /api/2.3/pods

/api/2.3/pods

Modify a pod

Modifies pod details.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
abort_quiesce	boolean Set to `true` to promote the pod when the `pod-replica-link` is in the `quiescing` state and abort when waiting for the `pod-replica-link` to complete the quiescing operation.
quiesce	boolean Set to `true` to demote the pod after the `pod-replica-link` goes into `quiesced` state and allow the pod to become a target of the remote pod. This ensures that all local data has been replicated to the remote pod before the pod is demoted.
skip_quiesce	boolean Set to `true` to demote the pod without quiescing the `pod-replica-link` and allow the pod to become a target of the remote pod. This stops all pending replication to the remote pod.
promote_from	string The `undo-demote` pod that should be used to promote the pod. After the pod has been promoted, it will have the same data as the `undo-demote` pod and the `undo-demote` pod will be eradicated.
destroy_contents	boolean Set to `true` to destroy contents (e.g., volumes, protection groups, snapshots) and containers (e.g., pods, volume groups). This enables you to destroy containers with contents.

Request Body schema: application/json

name	string A user-specified name. The name must be locally unique and can be changed.
destroyed	boolean If set to `true`, the pod has been destroyed and is pending eradication. The `time_remaining` value displays the amount of time left until the destroyed pod is permanently eradicated. A pod can only be destroyed if it is empty, so before destroying a pod, ensure all volumes and protection groups inside the pod have been either moved out of the pod or destroyed. A stretched pod cannot be destroyed unless you unstretch it first. Before the `time_remaining` period has elapsed, the destroyed pod can be recovered by setting `destroyed=false`. Once the `time_remaining` period has elapsed, the pod is permanently eradicated and can no longer be recovered.
failover_preferences	Array of objects Determines which array within a stretched pod should be given priority to stay online should the arrays ever lose contact with each other. The current array and any peer arrays that are connected to the current array for synchronous replication can be added to a pod for failover preference. By default, `failover_preferences=null`, meaning no arrays have been configured for failover preference. Enter multiple arrays in comma-separated format.
mediator	string Sets the URL of the mediator for this pod, replacing the URL of the current mediator. By default, the Pure1 Cloud Mediator (`purestorage`) serves as the mediator.
requested_promotion_state	string Patch `requested_promotion_state` to `demoted` to demote the pod so that it can be used as a link target for continuous replication between pods. Demoted pods do not accept write requests, and a destroyed version of the pod with `undo-demote` appended to the pod name is created on the array with the state of the pod when it was in the promoted state. Patch `requested_promotion_state` to `promoted` to start the process of promoting the pod. The `promotion_status` indicates when the pod has been successfully promoted. Promoted pods stop incorporating replicated data from the source pod and start accepting write requests. The replication process does not stop when the source pod continues replicating data to the pod. The space consumed by the unique replicated data is tracked by the `space.journal` field of the pod.

Responses

200

patch /api/2.3/pods

/api/2.3/pods

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"name": "string",
"destroyed": true,
"failover_preferences":
[
- {
  - "id": "string",
  - "name": "string"
  }
],
"mediator": "https://mediator.cloud-support.purestorage.com",
"requested_promotion_state": "string"

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "arrays":
    [
    {
    "id": "string",
    "name": "string",
    "frozen_at": 1492662000,
    "mediator_status": "string",
    "pre_elected": true,
    "progress": 0.66,
    "status": "resyncing"
    }
    ],
  - "destroyed": true,
  - "failover_preferences":
    [
    {
    "id": "string",
    "name": "string"
    }
    ],
  - "footprint": 0,
  - "mediator": "https://mediator.cloud-support.purestorage.com",
  - "mediator_version": "1.0.0",
  - "source":
    {
    "id": "string",
    "name": "string"
    },
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0,
    "replication": 0
    },
  - "time_remaining": 0,
  - "requested_promotion_state": "string",
  - "promotion_status": "string",
  - "link_source_count": 1,
  - "link_target_count": 1,
  - "array_count": 1
  }
]

}

List pods and their the array members

Returns a list of pods and the local and remote arrays over which the pods are stretched. The optional group_names parameter represents the name of the pod. The optional member_names parameter represents the name of the array over which the pod is stretched.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
group_ids	Array of strings A comma-separated list of group IDs.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
member_ids	Array of strings Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` and `member_names` parameters cannot be provided together.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/pods/arrays

/api/2.3/pods/arrays

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "group":
    {
    "id": "string",
    "name": "string"
    },
  - "member":
    {
    "id": "string",
    "name": "string"
    }
  }
]

}

Stretch a pod to an array

Stretches a pod to an array. When a pod is stretched to an array, the data in the arrays over which the pod is stretched is synchronously replicated. The group_names parameter represents the name of the pod to be stretched. The member_names parameter represents the name of the array over which the pod is to be stretched. The group_names and member_names parameters are required and must be set together.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
group_ids	Array of strings A comma-separated list of group IDs.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
member_ids	Array of strings Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` and `member_names` parameters cannot be provided together.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

post /api/2.3/pods/arrays

/api/2.3/pods/arrays

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "group":
    {
    "id": "string",
    "name": "string"
    },
  - "member":
    {
    "id": "string",
    "name": "string"
    }
  }
]

}

Unstretch a pod from an array

Unstretches a pod from an array, collapsing the pod to a single array. Unstretch a pod from an array when the volumes within the stretched pod no longer need to be synchronously replicated between the two arrays. After a pod has been unstretched, synchronous replication stops. A destroyed version of the pod with "restretch" appended to the pod name is created on the array that no longer has the pod. The restretch pod represents a point-in-time snapshot of the pod, just before it was unstretched. The restretch pod enters an eradication pending period starting from the time that the pod was unstretched. A restretch can pod can be cloned or destroyed, but it cannot be explicitly recovered. The group_names parameter represents the name of the pod to be unstretched. The member_names parameter represents the name of the array from which the pod is to be unstretched. The group_names and member_names parameters are required and must be set together.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
group_ids	Array of strings A comma-separated list of group IDs.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
member_ids	Array of strings Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` and `member_names` parameters cannot be provided together.
with_unknown	boolean If set to `true`, unstretches the specified pod from the specified array by force. Use the `with_unknown` parameter in the following rare event: the local array goes offline while the pod is still stretched across two arrays, the status of the remote array becomes unknown, and there is no guarantee that the pod is online elsewhere.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/pods/arrays

/api/2.3/pods/arrays

List pod performance data

Returns real-time and historical performance data, real-time latency data, and average I/O sizes across all pods, displayed both by pod and as a total across all pods.

query Parameters

destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
end_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
resolution	integer <int64> >= 0 Example: 30000 The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`<object name>/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`<object name>/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution.
start_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/pods/performance

/api/2.3/pods/performance

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "bytes_per_mirrored_write": 0,
  - "bytes_per_op": 0,
  - "bytes_per_read": 0,
  - "bytes_per_write": 0,
  - "mirrored_write_bytes_per_sec": 0,
  - "mirrored_writes_per_sec": 0,
  - "qos_rate_limit_usec_per_mirrored_write_op": 0,
  - "qos_rate_limit_usec_per_read_op": 0,
  - "qos_rate_limit_usec_per_write_op": 0,
  - "queue_usec_per_mirrored_write_op": 0,
  - "queue_usec_per_read_op": 0,
  - "queue_usec_per_write_op": 0,
  - "read_bytes_per_sec": 0,
  - "reads_per_sec": 0,
  - "san_usec_per_mirrored_write_op": 0,
  - "san_usec_per_read_op": 0,
  - "san_usec_per_write_op": 0,
  - "service_usec_per_mirrored_write_op": 0,
  - "service_usec_per_read_op": 0,
  - "service_usec_per_write_op": 0,
  - "time": 0,
  - "usec_per_mirrored_write_op": 0,
  - "usec_per_read_op": 0,
  - "usec_per_write_op": 0,
  - "write_bytes_per_sec": 0,
  - "writes_per_sec": 0
  }
],
"total":
[
- {
  - "id": "string",
  - "name": "string",
  - "bytes_per_mirrored_write": 0,
  - "bytes_per_op": 0,
  - "bytes_per_read": 0,
  - "bytes_per_write": 0,
  - "mirrored_write_bytes_per_sec": 0,
  - "mirrored_writes_per_sec": 0,
  - "qos_rate_limit_usec_per_mirrored_write_op": 0,
  - "qos_rate_limit_usec_per_read_op": 0,
  - "qos_rate_limit_usec_per_write_op": 0,
  - "queue_usec_per_mirrored_write_op": 0,
  - "queue_usec_per_read_op": 0,
  - "queue_usec_per_write_op": 0,
  - "read_bytes_per_sec": 0,
  - "reads_per_sec": 0,
  - "san_usec_per_mirrored_write_op": 0,
  - "san_usec_per_read_op": 0,
  - "san_usec_per_write_op": 0,
  - "service_usec_per_mirrored_write_op": 0,
  - "service_usec_per_read_op": 0,
  - "service_usec_per_write_op": 0,
  - "time": 0,
  - "usec_per_mirrored_write_op": 0,
  - "usec_per_read_op": 0,
  - "usec_per_write_op": 0,
  - "write_bytes_per_sec": 0,
  - "writes_per_sec": 0
  }
]

}

List pod performance data by array

Returns real-time and historical performance data, real-time latency data, and average I/O size data. The data is displayed as a total across all pods on the local array and by individual pod.

query Parameters

destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
end_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
resolution	integer <int64> >= 0 Example: 30000 The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`<object name>/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`<object name>/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution.
start_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/pods/performance/by-array

/api/2.3/pods/performance/by-array

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "bytes_per_mirrored_write": 0,
  - "bytes_per_op": 0,
  - "bytes_per_read": 0,
  - "bytes_per_write": 0,
  - "mirrored_write_bytes_per_sec": 0,
  - "mirrored_writes_per_sec": 0,
  - "qos_rate_limit_usec_per_mirrored_write_op": 0,
  - "qos_rate_limit_usec_per_read_op": 0,
  - "qos_rate_limit_usec_per_write_op": 0,
  - "queue_usec_per_mirrored_write_op": 0,
  - "queue_usec_per_read_op": 0,
  - "queue_usec_per_write_op": 0,
  - "read_bytes_per_sec": 0,
  - "reads_per_sec": 0,
  - "san_usec_per_mirrored_write_op": 0,
  - "san_usec_per_read_op": 0,
  - "san_usec_per_write_op": 0,
  - "service_usec_per_mirrored_write_op": 0,
  - "service_usec_per_read_op": 0,
  - "service_usec_per_write_op": 0,
  - "time": 0,
  - "usec_per_mirrored_write_op": 0,
  - "usec_per_read_op": 0,
  - "usec_per_write_op": 0,
  - "write_bytes_per_sec": 0,
  - "writes_per_sec": 0,
  - "array":
    {
    "id": "string",
    "name": "string"
    }
  }
],
"total":
[
- {
  - "id": "string",
  - "name": "string",
  - "bytes_per_mirrored_write": 0,
  - "bytes_per_op": 0,
  - "bytes_per_read": 0,
  - "bytes_per_write": 0,
  - "mirrored_write_bytes_per_sec": 0,
  - "mirrored_writes_per_sec": 0,
  - "qos_rate_limit_usec_per_mirrored_write_op": 0,
  - "qos_rate_limit_usec_per_read_op": 0,
  - "qos_rate_limit_usec_per_write_op": 0,
  - "queue_usec_per_mirrored_write_op": 0,
  - "queue_usec_per_read_op": 0,
  - "queue_usec_per_write_op": 0,
  - "read_bytes_per_sec": 0,
  - "reads_per_sec": 0,
  - "san_usec_per_mirrored_write_op": 0,
  - "san_usec_per_read_op": 0,
  - "san_usec_per_write_op": 0,
  - "service_usec_per_mirrored_write_op": 0,
  - "service_usec_per_read_op": 0,
  - "service_usec_per_write_op": 0,
  - "time": 0,
  - "usec_per_mirrored_write_op": 0,
  - "usec_per_read_op": 0,
  - "usec_per_write_op": 0,
  - "write_bytes_per_sec": 0,
  - "writes_per_sec": 0,
  - "array":
    {
    "id": "string",
    "name": "string"
    }
  }
]

}

List pod replication performance data

Displays pod replication performance data, organized by array. The data returned is the real-time and historical performance data for each replication type at the pod level. Values include continuous, periodic, resync, and sync.

query Parameters

destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
end_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
resolution	integer <int64> >= 0 Example: 30000 The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`<object name>/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`<object name>/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution.
start_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/pods/performance/replication

/api/2.3/pods/performance/replication

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "continuous_bytes_per_sec":
    {
    "from_remote_bytes_per_sec": 0,
    "to_remote_bytes_per_sec": 0,
    "total_bytes_per_sec": 0
    },
  - "pod":
    {
    "id": "string",
    "name": "string"
    },
  - "resync_bytes_per_sec":
    {
    "from_remote_bytes_per_sec": 0,
    "to_remote_bytes_per_sec": 0,
    "total_bytes_per_sec": 0
    },
  - "sync_bytes_per_sec":
    {
    "from_remote_bytes_per_sec": 0,
    "to_remote_bytes_per_sec": 0,
    "total_bytes_per_sec": 0
    },
  - "time": 0,
  - "total_bytes_per_sec": 0
  }
],
"total":
[
- {
  - "continuous_bytes_per_sec":
    {
    "from_remote_bytes_per_sec": 0,
    "to_remote_bytes_per_sec": 0,
    "total_bytes_per_sec": 0
    },
  - "pod":
    {
    "id": "string",
    "name": "string"
    },
  - "resync_bytes_per_sec":
    {
    "from_remote_bytes_per_sec": 0,
    "to_remote_bytes_per_sec": 0,
    "total_bytes_per_sec": 0
    },
  - "sync_bytes_per_sec":
    {
    "from_remote_bytes_per_sec": 0,
    "to_remote_bytes_per_sec": 0,
    "total_bytes_per_sec": 0
    },
  - "time": 0,
  - "total_bytes_per_sec": 0
  }
]

}

List pod replication performance data by array

query Parameters

destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
end_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
resolution	integer <int64> >= 0 Example: 30000 The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`<object name>/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`<object name>/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution.
start_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/pods/performance/replication/by-array

/api/2.3/pods/performance/replication/by-array

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "continuous_bytes_per_sec":
    {
    "from_remote_bytes_per_sec": 0,
    "to_remote_bytes_per_sec": 0,
    "total_bytes_per_sec": 0
    },
  - "pod":
    {
    "id": "string",
    "name": "string"
    },
  - "resync_bytes_per_sec":
    {
    "from_remote_bytes_per_sec": 0,
    "to_remote_bytes_per_sec": 0,
    "total_bytes_per_sec": 0
    },
  - "sync_bytes_per_sec":
    {
    "from_remote_bytes_per_sec": 0,
    "to_remote_bytes_per_sec": 0,
    "total_bytes_per_sec": 0
    },
  - "time": 0,
  - "total_bytes_per_sec": 0,
  - "array":
    {
    "id": "string",
    "name": "string"
    }
  }
],
"total":
[
- {
  - "continuous_bytes_per_sec":
    {
    "from_remote_bytes_per_sec": 0,
    "to_remote_bytes_per_sec": 0,
    "total_bytes_per_sec": 0
    },
  - "pod":
    {
    "id": "string",
    "name": "string"
    },
  - "resync_bytes_per_sec":
    {
    "from_remote_bytes_per_sec": 0,
    "to_remote_bytes_per_sec": 0,
    "total_bytes_per_sec": 0
    },
  - "sync_bytes_per_sec":
    {
    "from_remote_bytes_per_sec": 0,
    "to_remote_bytes_per_sec": 0,
    "total_bytes_per_sec": 0
    },
  - "time": 0,
  - "total_bytes_per_sec": 0,
  - "array":
    {
    "id": "string",
    "name": "string"
    }
  }
]

}

List pod space information

Displays provisioned (virtual) size and physical storage consumption data for each pod on the local array.

query Parameters

names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
end_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
resolution	integer <int64> >= 0 Example: 30000 The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`<object name>/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`<object name>/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution.
start_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/pods/space

/api/2.3/pods/space

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0,
    "replication": 0
    },
  - "time": 0
  }
],
"total":
[
- {
  - "id": "string",
  - "name": "string",
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0,
    "replication": 0
    },
  - "time": 0
  }
]

}

Policies

Policies endpoint description (placeholder)

List policies

Displays a list of policies.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/policies

/api/2.3/policies

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "enabled": true,
  - "policy_type": "string"
  }
]

}

List policy members

Displays a list of policy members.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_ids	Array of strings Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` and `member_names` parameters cannot be provided together.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
member_types	Array of strings Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include `directories`. Enter multiple member types in comma-separated format. For example, `type01,type02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` and `policy_names` parameters cannot be provided together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/policies/members

/api/2.3/policies/members

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "destroyed": true,
  - "enabled": true,
  - "member":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    },
  - "policy":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    }
  }
]

}

List NFS policies

Displays a list of NFS policies.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/policies/nfs

/api/2.3/policies/nfs

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "enabled": true,
  - "policy_type": "string"
  }
]

}

Create NFS policies

Creates one or more NFS policies.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

enabled

boolean

If set to true, enables the policy. If set to false, disables the policy.

Responses

200

post /api/2.3/policies/nfs

/api/2.3/policies/nfs

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"enabled": true

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "enabled": true,
  - "policy_type": "string"
  }
]

}

Delete NFS policies

Deletes one or more NFS policies. The ids or names parameter is required, but they cannot be set together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/policies/nfs

/api/2.3/policies/nfs

Modify NFS policies

Modifies one or more NFS policies. To enable a policy, set enabled=true. To disable a policy, set enabled=false. To rename a policy, set name to the new name. The ids or names parameter is required, but cannot be set together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

name	string The new name for the resource.
enabled	boolean If set to `true`, enables the policy. If set to `false`, disables the policy.

Responses

200

patch /api/2.3/policies/nfs

/api/2.3/policies/nfs

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"name": "string",
"enabled": true

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "enabled": true,
  - "policy_type": "string"
  }
]

}

List NFS client policy rules

Displays a list of NFS client policy rules.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` and `policy_names` parameters cannot be provided together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/policies/nfs/client-rules

/api/2.3/policies/nfs/client-rules

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "access": "string",
  - "client": "string",
  - "name": "string",
  - "permission": "string",
  - "policy":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    }
  }
]

}

Create NFS client policy rules

Creates one or more NFS client policy rules. The policy_ids or policy_names parameter is required, but cannot be set together.

query Parameters

policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` and `policy_names` parameters cannot be provided together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

rules

Array of objects

A list of NFS policy rules to create.

Responses

200

post /api/2.3/policies/nfs/client-rules

/api/2.3/policies/nfs/client-rules

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"rules":
[
- {
  - "access": "string",
  - "client": "string",
  - "permission": "string"
  }
]

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "access": "string",
  - "client": "string",
  - "name": "string",
  - "permission": "string",
  - "policy":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    }
  }
]

}

Delete NFS client policy rules.

Delete one or more NFS client policy rules. The policy_ids or policy_names parameter is required, but they cannot be set together.

query Parameters

names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` and `policy_names` parameters cannot be provided together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/policies/nfs/client-rules

/api/2.3/policies/nfs/client-rules

List NFS policy members

Displays a list of NFS policy members.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_ids	Array of strings Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` and `member_names` parameters cannot be provided together.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
member_types	Array of strings Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include `directories`. Enter multiple member types in comma-separated format. For example, `type01,type02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` and `policy_names` parameters cannot be provided together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/policies/nfs/members

/api/2.3/policies/nfs/members

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "destroyed": true,
  - "enabled": true,
  - "member":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    },
  - "policy":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    },
  - "export_name": "string"
  }
]

}

Create NFS policies

Creates a membership between one or more resources with an NFS policy. Applicable resources are directories. The policy_ids or policy_names parameter is required, but cannot be set together.

query Parameters

policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` and `policy_names` parameters cannot be provided together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

members

Array of objects

A list of directories to which the export policy may be applied.

Responses

200

post /api/2.3/policies/nfs/members

/api/2.3/policies/nfs/members

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"members":
[
- {
  - "export_name": "string",
  - "member":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    }
  }
]

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "destroyed": true,
  - "enabled": true,
  - "member":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    },
  - "policy":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    },
  - "export_name": "string"
  }
]

}

Delete NFS policies

Deletes one or more NFS policies from resources. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

query Parameters

member_ids	Array of strings Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` and `member_names` parameters cannot be provided together.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
member_types	Array of strings Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include `directories`. Enter multiple member types in comma-separated format. For example, `type01,type02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` and `policy_names` parameters cannot be provided together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/policies/nfs/members

/api/2.3/policies/nfs/members

List SMB policies

Displays a list of SMB policies.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/policies/smb

/api/2.3/policies/smb

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "enabled": true,
  - "policy_type": "string"
  }
]

}

Create SMB policies

Creates one or more SMB policies.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

enabled

boolean

If set to true, enables the policy. If set to false, disables the policy.

Responses

200

post /api/2.3/policies/smb

/api/2.3/policies/smb

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"enabled": true

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "enabled": true,
  - "policy_type": "string"
  }
]

}

Delete SMB policies

Deletes one or more SMB policies. The ids or names parameter is required, but they cannot be set together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/policies/smb

/api/2.3/policies/smb

Modify SMB policies

Modifies one or more SMB policies. To enable a policy, set enabled=true. To disable a policy, set enabled=false. To rename a policy, set name to the new name. The ids or names parameter is required, but cannot be set together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

name	string The new name for the resource.
enabled	boolean If set to `true`, enables the policy. If set to `false`, disables the policy.

Responses

200

patch /api/2.3/policies/smb

/api/2.3/policies/smb

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"name": "string",
"enabled": true

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "enabled": true,
  - "policy_type": "string"
  }
]

}

List SMB client policy rules

Displays a list of SMB client policy rules.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` and `policy_names` parameters cannot be provided together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/policies/smb/client-rules

/api/2.3/policies/smb/client-rules

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "anonymous_access_allowed": true,
  - "client": "string",
  - "name": "string",
  - "policy":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    },
  - "smb_encryption_required": true
  }
]

}

Create SMB client policy rules

Create one or more SMB client policy rules. The policy_ids or policy_names parameter is required, but cannot be set together.

query Parameters

policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` and `policy_names` parameters cannot be provided together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

rules

Array of objects

A list of SMB policy rules to create.

Responses

200

post /api/2.3/policies/smb/client-rules

/api/2.3/policies/smb/client-rules

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"rules":
[
- {
  - "anonymous_access_allowed": true,
  - "client": "string",
  - "smb_encryption_required": true
  }
]

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "anonymous_access_allowed": true,
  - "client": "string",
  - "name": "string",
  - "policy":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    },
  - "smb_encryption_required": true
  }
]

}

Delete SMB client policy rules.

Deletes one or more SMB client policy rules. The policy_ids or policy_names parameter is required, but they cannot be set together.

query Parameters

names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` and `policy_names` parameters cannot be provided together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/policies/smb/client-rules

/api/2.3/policies/smb/client-rules

List SMB policy members

Displays a list of SMB policy members.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_ids	Array of strings Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` and `member_names` parameters cannot be provided together.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
member_types	Array of strings Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include `directories`. Enter multiple member types in comma-separated format. For example, `type01,type02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` and `policy_names` parameters cannot be provided together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/policies/smb/members

/api/2.3/policies/smb/members

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "destroyed": true,
  - "enabled": true,
  - "member":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    },
  - "policy":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    },
  - "export_name": "string"
  }
]

}

Create SMB policies

Creates a membership between one or more resources with an SMB policy. Applicable resources are directories. The policy_ids or policy_names parameter is required, but cannot be set together.

query Parameters

policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` and `policy_names` parameters cannot be provided together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

members

Array of objects

A list of directories to which the export policy may be applied.

Responses

200

post /api/2.3/policies/smb/members

/api/2.3/policies/smb/members

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"members":
[
- {
  - "export_name": "string",
  - "member":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    }
  }
]

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "destroyed": true,
  - "enabled": true,
  - "member":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    },
  - "policy":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    },
  - "export_name": "string"
  }
]

}

Delete SMB policies

Deletes one or more SMB policies from resources. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

query Parameters

member_ids	Array of strings Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` and `member_names` parameters cannot be provided together.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
member_types	Array of strings Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include `directories`. Enter multiple member types in comma-separated format. For example, `type01,type02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` and `policy_names` parameters cannot be provided together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/policies/smb/members

/api/2.3/policies/smb/members

List snapshot policies

Displays a list of snapshot policies.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/policies/snapshot

/api/2.3/policies/snapshot

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "enabled": true,
  - "policy_type": "string"
  }
]

}

Create snapshot policies

Creates one or more snapshot policies.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

enabled

boolean

If set to true, enables the policy. If set to false, disables the policy.

Responses

200

post /api/2.3/policies/snapshot

/api/2.3/policies/snapshot

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"enabled": true

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "enabled": true,
  - "policy_type": "string"
  }
]

}

Delete snapshot policies

Deletes one or more snapshot policies. The ids or names parameter is required, but they cannot be set together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/policies/snapshot

/api/2.3/policies/snapshot

Modify snapshot policies

Modifies one or more snapshot policies. To enable a policy, set enabled=true. To disable a policy, set enabled=true. To rename a policy, set name to the new name. The ids or names parameter is required, but cannot be set together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

name	string The new name for the resource.
enabled	boolean If set to `true`, enables the policy. If set to `false`, disables the policy.

Responses

200

patch /api/2.3/policies/snapshot

/api/2.3/policies/snapshot

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"name": "string",
"enabled": true

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "enabled": true,
  - "policy_type": "string"
  }
]

}

List snapshot policy members

Displays a list of snapshot policy members.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_ids	Array of strings Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` and `member_names` parameters cannot be provided together.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
member_types	Array of strings Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include `directories`. Enter multiple member types in comma-separated format. For example, `type01,type02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` and `policy_names` parameters cannot be provided together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/policies/snapshot/members

/api/2.3/policies/snapshot/members

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "destroyed": true,
  - "enabled": true,
  - "member":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    },
  - "policy":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    }
  }
]

}

Create snapshot policies

Creates a membership between one or more resources with a snapshot policy. Applicable resources are directories. The policy_ids or policy_names parameter is required, but cannot be set together.

query Parameters

policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` and `policy_names` parameters cannot be provided together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

members

Array of objects

A list of resources to which the policy may be applied.

Responses

200

post /api/2.3/policies/snapshot/members

/api/2.3/policies/snapshot/members

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"members":
[
- {
  - "member":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    }
  }
]

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "destroyed": true,
  - "enabled": true,
  - "member":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    },
  - "policy":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    }
  }
]

}

Delete snapshot policies

Deletes one or more snapshot policies from resources. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together.

query Parameters

member_ids	Array of strings Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` and `member_names` parameters cannot be provided together.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
member_types	Array of strings Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include `directories`. Enter multiple member types in comma-separated format. For example, `type01,type02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` and `policy_names` parameters cannot be provided together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/policies/snapshot/members

/api/2.3/policies/snapshot/members

List snapshot policy rules

Displays a list of snapshot policy rules.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` and `policy_names` parameters cannot be provided together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/policies/snapshot/rules

/api/2.3/policies/snapshot/rules

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "at": 0,
  - "client_name": "string",
  - "every": 0,
  - "keep_for": 0,
  - "name": "string",
  - "policy":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    }
  }
]

}

Create snapshot policy rules

Creates one or more snapshot policy rules. The policy_ids or policy_names parameter is required, but cannot be set together.

query Parameters

policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` and `policy_names` parameters cannot be provided together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

rules

Array of objects

A list of snapshot policy rules to create.

Responses

200

post /api/2.3/policies/snapshot/rules

/api/2.3/policies/snapshot/rules

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"rules":
[
- {
  - "at": 0,
  - "client_name": "string",
  - "every": 0,
  - "keep_for": 0
  }
]

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "at": 0,
  - "client_name": "string",
  - "every": 0,
  - "keep_for": 0,
  - "name": "string",
  - "policy":
    {
    "id": "string",
    "name": "string",
    "resource_type": "string"
    }
  }
]

}

Delete snapshot policy rules.

Deletes one or more snapshot policy rules. The policy_ids or policy_names parameter is required, but they cannot be set together.

query Parameters

names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
policy_ids	Array of strings Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The `policy_ids` and `policy_names` parameters cannot be provided together.
policy_names	Array of strings Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/policies/snapshot/rules

/api/2.3/policies/snapshot/rules

Ports

Ports endpoint description (placeholder)

List ports

Displays host name, iSCSI Qualified Names (IQNs), NVMe Qualified Names (NQNs), IPv4 address of the portal, Fibre Channel World Wide Names (WWNs), and failover ports, including those that were discovered by Purity//FA and those that have been manually assigned by system administrators.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/ports

/api/2.3/ports

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "name": "string",
  - "iqn": "iqn.2010-06.com.purestorage:flasharray.393d930077be2977",
  - "nqn": "nqn.2010-06.com.purestorage:flasharray.512f7bb185978505",
  - "portal": "10.16.200.27:3260",
  - "wwn": "52:4A:93:70:4E:E5:68:00",
  - "failover": "CT0.ETH2"
  }
]

}

List port initiators

Displays host iSCSI Qualified Names (IQNs), NVMe Qualified Names (NQNs), and Fibre Channel World Wide Names (WWNs), including those that were discovered by Purity//FA and those that have been manually assigned by system administrators, along with the array ports (targets) on which they are eligible to communicate.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/ports/initiators

/api/2.3/ports/initiators

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "initiator":
    {
    "iqn": "iqn.2010-06.com.purestorage:flasharray.393d930077be2977",
    "nqn": "nqn.2010-06.com.purestorage:flasharray.512f7bb185978505",
    "portal": "10.16.200.27:3260",
    "wwn": "52:4A:93:70:4E:E5:68:00"
    },
  - "target":
    {
    "name": "string",
    "iqn": "iqn.2010-06.com.purestorage:flasharray.393d930077be2977",
    "nqn": "nqn.2010-06.com.purestorage:flasharray.512f7bb185978505",
    "portal": "10.16.200.27:3260",
    "wwn": "52:4A:93:70:4E:E5:68:00",
    "failover": "CT0.ETH2"
    }
  }
]

}

Protection Groups

A protection group defines a set of volumes, hosts, or host groups (called members) that are protected together through snapshots with point-in-time consistency across the member volumes. The members within the protection group have common data protection requirements and the same snapshot, replication, and retention schedules. Protection group members include volumes, hosts, and host groups. After a protection group has been created, configure the protection group schedule to generate and replicate snapshots to another array or to an external storage system.

List protection groups

Returns a list of protection groups, including their associated source arrays, replication targets, hosts, host groups, and volumes. The list includes protection groups that were created on the local array to replicate snapshot data to other arrays or offload targets, created on a remote array and replicated asynchronously to this array, or created inside a pod on a remote array and stretched to the local array.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/protection-groups

/api/2.3/protection-groups

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "name": "string",
  - "destroyed": true,
  - "host_count": 3,
  - "host_group_count": 3,
  - "is_local": true,
  - "pod":
    {
    "id": "string",
    "name": "string"
    },
  - "replication_schedule":
    {
    "at": 7200000,
    "enabled": false,
    "frequency": 259200000,
    "blackout":
    {
    "start": 3600000,
    "end": 46800000
    }
    },
  - "snapshot_schedule":
    {
    "at": 7200000,
    "enabled": false,
    "frequency": 259200000
    },
  - "source":
    {
    "id": "string",
    "name": "string"
    },
  - "source_retention":
    {
    "all_for_sec": 86400,
    "days": 7,
    "per_day": 3
    },
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "target_count": 3,
  - "target_retention":
    {
    "all_for_sec": 86400,
    "days": 7,
    "per_day": 3
    },
  - "time_remaining": 0,
  - "volume_count": 3
  }
],
"total":
[
- {
  - "name": "string",
  - "destroyed": true,
  - "host_count": 3,
  - "host_group_count": 3,
  - "is_local": true,
  - "pod":
    {
    "id": "string",
    "name": "string"
    },
  - "replication_schedule":
    {
    "at": 7200000,
    "enabled": false,
    "frequency": 259200000,
    "blackout":
    {
    "start": 3600000,
    "end": 46800000
    }
    },
  - "snapshot_schedule":
    {
    "at": 7200000,
    "enabled": false,
    "frequency": 259200000
    },
  - "source":
    {
    "id": "string",
    "name": "string"
    },
  - "source_retention":
    {
    "all_for_sec": 86400,
    "days": 7,
    "per_day": 3
    },
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "target_count": 3,
  - "target_retention":
    {
    "all_for_sec": 86400,
    "days": 7,
    "per_day": 3
    },
  - "time_remaining": 0,
  - "volume_count": 3
  }
]

}

Create a protection group

Creates a protection group on the local array for asynchronous replication.

query Parameters

names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
source_names	Array of strings The name of the protection group or protection group snapshot to be copied into a new or existing protection group. If the destination protection group and all of its volumes already exist, include the `overwrite` parameter to overwrite all of the existing volumes with the snapshot contents. If including the `overwrite` parameter, the names of the volumes that are being overwritten must match the names of the volumes that are being restored. If the source is a protection group, the latest snapshot of the protection group will be used as the source during the copy operation.
overwrite	boolean If set to `true`, overwrites an existing volume during a volume copy operation. If set to `false` or not set at all and the target name is an existing volume, the volume copy operation fails. Required if the `source: id` or `source: name` body parameter is set and the source overwrites an existing volume during the volume copy operation.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

post /api/2.3/protection-groups

/api/2.3/protection-groups

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "name": "string",
  - "destroyed": true,
  - "host_count": 3,
  - "host_group_count": 3,
  - "is_local": true,
  - "pod":
    {
    "id": "string",
    "name": "string"
    },
  - "replication_schedule":
    {
    "at": 7200000,
    "enabled": false,
    "frequency": 259200000,
    "blackout":
    {
    "start": 3600000,
    "end": 46800000
    }
    },
  - "snapshot_schedule":
    {
    "at": 7200000,
    "enabled": false,
    "frequency": 259200000
    },
  - "source":
    {
    "id": "string",
    "name": "string"
    },
  - "source_retention":
    {
    "all_for_sec": 86400,
    "days": 7,
    "per_day": 3
    },
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "target_count": 3,
  - "target_retention":
    {
    "all_for_sec": 86400,
    "days": 7,
    "per_day": 3
    },
  - "time_remaining": 0,
  - "volume_count": 3
  }
]

}

Eradicate a protection group

Eradicates a protection group that has been destroyed and is pending eradication. Eradicated protection groups cannot be recovered. Protection groups are destroyed through the PATCH method. Theids or names parameter is required, but cannot be set together.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/protection-groups

/api/2.3/protection-groups

Manage a protection group

Configures the protection group schedules to generate and replicate snapshots to another array or to an external storage system. Also renames or destroys a protection group.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

name	string A user-specified name. The name must be locally unique and can be changed.
destroyed	boolean Has this protection group been destroyed? To destroy a protection group, patch to `true`. To recover a destroyed protection group, patch to `false`. If not specified, defaults to `false`.
replication_schedule	object The schedule settings for asynchronous replication.
snapshot_schedule	object The replication or snapshot schedule.
source_retention	object The snapshot retention policy.
target_retention	object The snapshot retention policy.

Responses

200

patch /api/2.3/protection-groups

/api/2.3/protection-groups

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"name": "string",
"destroyed": true,
"replication_schedule":
{
- "at": 7200000,
- "enabled": false,
- "frequency": 259200000,
- "blackout":
  {
  - "start": 3600000,
  - "end": 46800000
  }
},
"snapshot_schedule":
{
- "at": 7200000,
- "enabled": false,
- "frequency": 259200000
},
"source_retention":
{
- "all_for_sec": 86400,
- "days": 7,
- "per_day": 3
},
"target_retention":
{
- "all_for_sec": 86400,
- "days": 7,
- "per_day": 3
}

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "name": "string",
  - "destroyed": true,
  - "host_count": 3,
  - "host_group_count": 3,
  - "is_local": true,
  - "pod":
    {
    "id": "string",
    "name": "string"
    },
  - "replication_schedule":
    {
    "at": 7200000,
    "enabled": false,
    "frequency": 259200000,
    "blackout":
    {
    "start": 3600000,
    "end": 46800000
    }
    },
  - "snapshot_schedule":
    {
    "at": 7200000,
    "enabled": false,
    "frequency": 259200000
    },
  - "source":
    {
    "id": "string",
    "name": "string"
    },
  - "source_retention":
    {
    "all_for_sec": 86400,
    "days": 7,
    "per_day": 3
    },
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "target_count": 3,
  - "target_retention":
    {
    "all_for_sec": 86400,
    "days": 7,
    "per_day": 3
    },
  - "time_remaining": 0,
  - "volume_count": 3
  }
]

}

List protection groups with host members

Returns a list of protection groups that have host members.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/protection-groups/hosts

/api/2.3/protection-groups/hosts

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "group":
    {
    "name": "string"
    },
  - "member":
    {
    "name": "string"
    }
  }
]

}

Add a host to a protection group

Adds a host member to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host. The group_names and member_names parameters are required and must be set together.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

post /api/2.3/protection-groups/hosts

/api/2.3/protection-groups/hosts

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "group":
    {
    "name": "string"
    },
  - "member":
    {
    "name": "string"
    }
  }
]

}

Remove a host from a protection group

Removes a host member from a protection group. After the member has been removed, it is no longer protected by the group. Any protection group snapshots that were taken before the member was removed will not be affected. Removing a member from a protection group does not delete the member from the array, and the member can be added back to the protection group at any time. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host. The group_names and member_names parameters are required and must be set together.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/protection-groups/hosts

/api/2.3/protection-groups/hosts

List protection groups with host group members

Returns a list of protection groups that have host group members.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/protection-groups/host-groups

/api/2.3/protection-groups/host-groups

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "group":
    {
    "name": "string"
    },
  - "member":
    {
    "name": "string"
    }
  }
]

}

Add a host group to a protection group

Adds a host group member to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host group. The group_names and member_names parameters are required and must be set together.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

post /api/2.3/protection-groups/host-groups

/api/2.3/protection-groups/host-groups

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "group":
    {
    "name": "string"
    },
  - "member":
    {
    "name": "string"
    }
  }
]

}

Remove a host group from a protection group

Removes a host group member from a protection group. After the member has been removed, it is no longer protected by the group. Any protection group snapshots that were taken before the member was removed will not be affected. Removing a member from a protection group does not delete the member from the array, and the member can be added back to the protection group at any time. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host group. The group_names and member_names parameters are required and must be set together.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/protection-groups/host-groups

/api/2.3/protection-groups/host-groups

List protection group replication performance data

Returns the total number of bytes of replication data transmitted and received per second. The data is grouped by protection group.

query Parameters

names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
end_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
resolution	integer <int64> >= 0 Example: 30000 The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`<object name>/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`<object name>/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution.
start_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/protection-groups/performance/replication

/api/2.3/protection-groups/performance/replication

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "name": "string",
  - "bytes_per_sec": 0,
  - "time": 0
  }
]

}

List protection group replication performance data with array details

Returns the total number of bytes of replication data transmitted and received per second. The data is grouped by protection group and includes the names of the source array and targets for each protection group.

query Parameters

names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
end_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
resolution	integer <int64> >= 0 Example: 30000 The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`<object name>/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`<object name>/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution.
start_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/protection-groups/performance/replication/by-array

/api/2.3/protection-groups/performance/replication/by-array

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "name": "string",
  - "bytes_per_sec": 0,
  - "source": "string",
  - "target": "string",
  - "time": 0
  }
]

}

List protection group space information

Returns provisioned (virtual) size and physical storage consumption data for each protection group.

query Parameters

destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/protection-groups/space

/api/2.3/protection-groups/space

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "name": "string",
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "time": 0
  }
]

}

List protection groups with targets

Returns a list of protection groups that have target arrays or offload targets.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/protection-groups/targets

/api/2.3/protection-groups/targets

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "group":
    {
    "name": "string"
    },
  - "member":
    {
    "name": "string"
    },
  - "allowed": true
  }
]

}

Add a target to a protection group

Adds an array or offload target to a protection group. The group_names parameter represents the name of the protection group. The member_names parameter represents the name of the array or offload target that is being added to the protection group. The group_names and member_names parameters are required and must be set together.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

post /api/2.3/protection-groups/targets

/api/2.3/protection-groups/targets

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "group":
    {
    "name": "string"
    },
  - "member":
    {
    "name": "string"
    },
  - "allowed": true
  }
]

}

Manage a protection group target

Allows the source array to replicate protection group data to the target array, or disallows the source array from replicating protection group data to the target array. The allowed parameter must be set from the target array. The group_names parameter represents the name of the protection group. The allowed and group_names parameters are required and must be set together. Offload targets do not support the allowed parameter.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

allowed

boolean

If set to true, the target array has allowed the source array to replicate protection group data to the target array. If set to false, the target array has not allowed the source array to replicate protection group data to the target. target-protection-group

Responses

200

patch /api/2.3/protection-groups/targets

/api/2.3/protection-groups/targets

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"allowed": true

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "group":
    {
    "name": "string"
    },
  - "member":
    {
    "name": "string"
    },
  - "allowed": true
  }
]

}

Removes a target from a protection group

Removes an array or offload target from a protection group. The group_names parameter represents the name of the protection group. The member_names parameter represents the name of the array or offload target that is being removed from the protection group. The group_names and member_names parameters are required and must be set together.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/protection-groups/targets

/api/2.3/protection-groups/targets

List protection groups with volume members

Returns a list of protection groups that have volume members.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/protection-groups/volumes

/api/2.3/protection-groups/volumes

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "group":
    {
    "name": "string"
    },
  - "member":
    {
    "name": "string"
    }
  }
]

}

Add a volume to a protection group

Adds a volume member to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the volume. The group_names and member_names parameters are required and must be set together.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

post /api/2.3/protection-groups/volumes

/api/2.3/protection-groups/volumes

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "group":
    {
    "name": "string"
    },
  - "member":
    {
    "name": "string"
    }
  }
]

}

Remove a volume from a protection group

Removes a volume member from a protection group. After the member has been removed, it is no longer protected by the group. Any protection group snapshots that were taken before the member was removed will not be affected. Removing a member from a protection group does not delete the member from the array, and the member can be added back to the protection group at any time. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the volume. The group_names and member_names parameters are required and must be set together.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/protection-groups/volumes

/api/2.3/protection-groups/volumes

Protection Group Snapshots

Protection group snapshots capture the content of all volumes on the source array for the specified protection group at a single point in time. The snapshot is an immutable image of the volume data at that instance in time. The volumes are either direct members of the protection group or connected to any of its hosts or host groups within a protection group. Volumes are protected through protection group snapshots that are retained locally, replicated to other arrays or storage systems, or both. Protection group snapshots can be manually generated on demand or enabled to automatically generate at scheduled intervals. After a protection group snapshot has been taken, it is either stored on the local array or replicated over to a remote (target) array.

List protection group snapshots

Displays a list of protection group snapshots, including those pending eradication.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
source_names	Array of strings Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, `name01,name02`.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/protection-group-snapshots

/api/2.3/protection-group-snapshots

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "name": "string",
  - "created": 1503520993,
  - "destroyed": true,
  - "pod":
    {
    "id": "string",
    "name": "string"
    },
  - "source":
    {
    "id": "string",
    "name": "string"
    },
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "suffix": "string",
  - "time_remaining": 0
  }
],
"total":
[
- {
  - "name": "string",
  - "created": 1503520993,
  - "destroyed": true,
  - "pod":
    {
    "id": "string",
    "name": "string"
    },
  - "source":
    {
    "id": "string",
    "name": "string"
    },
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "suffix": "string",
  - "time_remaining": 0
  }
]

}

Create a protection group snapshot

Creates a point-in-time snapshot of the contents of a protection group. The source_names parameter is required.

query Parameters

apply_retention	boolean If `true`, applies the local and remote retention policy to the snapshots.
source_names	Array of strings Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

suffix

string

The name suffix appended to the protection group name to make up the full protection group snapshot name in the form PGROUP.SUFFIX. If suffix is not specified, the protection group name is in the form PGROUP.NNN, where NNN is a unique monotonically increasing number. If multiple protection group snapshots are created at a time, the suffix name is appended to those snapshots.

Responses

200

post /api/2.3/protection-group-snapshots

/api/2.3/protection-group-snapshots

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"name": "string",
"destroyed": true,
"suffix": "string"

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "name": "string",
  - "created": 1503520993,
  - "destroyed": true,
  - "pod":
    {
    "id": "string",
    "name": "string"
    },
  - "source":
    {
    "id": "string",
    "name": "string"
    },
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "suffix": "string",
  - "time_remaining": 0
  }
]

}

Delete a protection group snapshot

Deletes a protection group snapshot that has been destroyed and is pending eradication. Eradicating a protection group snapshot eradicates all of its protection group snapshots. Eradicated protection group snapshots cannot be recovered. Protection group snapshots are destroyed through the PATCH method. The ids or names parameter is required, but cannot be set together.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/protection-group-snapshots

/api/2.3/protection-group-snapshots

Modify a protection group snapshot

Modifies a protection group snapshot so that it can be destroyed. To destroy a volume, set destroyed=true. To recover a volume that has been destroyed and is pending eradication, set destroyed=false. The names parameter is required.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

name

string

A user-specified name. The name must be locally unique and can be changed.

destroyed

boolean

Returns a value of true if the protection group snapshot has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed snapshot is permanently eradicated. Before the time_remaining period has elapsed, the destroyed snapshot can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the snapshot is permanently eradicated and can no longer be recovered.

Responses

200

patch /api/2.3/protection-group-snapshots

/api/2.3/protection-group-snapshots

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"name": "string",
"destroyed": true,
"suffix": "string"

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "name": "string",
  - "created": 1503520993,
  - "destroyed": true,
  - "pod":
    {
    "id": "string",
    "name": "string"
    },
  - "source":
    {
    "id": "string",
    "name": "string"
    },
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "suffix": "string",
  - "time_remaining": 0
  }
]

}

List protection group snapshots with transfer statistics

Returns a list of protection group snapshots and their transfer statistics.

query Parameters

destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
source_names	Array of strings Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, `name01,name02`.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/protection-group-snapshots/transfer

/api/2.3/protection-group-snapshots/transfer

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "name": "string",
  - "destroyed": true,
  - "started": 0,
  - "progress": 0.66,
  - "completed": 0,
  - "data_transferred": 0,
  - "physical_bytes_written": 0
  }
],
"total":
[
- {
  - "name": "string",
  - "destroyed": true,
  - "started": 0,
  - "progress": 0.66,
  - "completed": 0,
  - "data_transferred": 0,
  - "physical_bytes_written": 0
  }
]

}

Remote Pods

A remote pod represents a pod that is on a connected array but not stretched to this array.

List remote pods

Returns a list of pods that that are on connected arrays but not stretched to this array.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
on	Array of strings Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, `targetName01,targetName02`.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/remote-pods

/api/2.3/remote-pods

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "arrays":
    [
    {
    "id": "string",
    "name": "string"
    }
    ]
  }
]

}

Remote Protection Groups

A remote protection group represents a protection group that resides on an offload target with the source side of the remote protection group being another array that is connected to the local array. The local array can only see the remote protection groups of other arrays if the two arrays are connected.

List remote protection groups

Returns a list of remote protection groups.

query Parameters

destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
on	Array of strings Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, `targetName01,targetName02`.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/remote-protection-groups

/api/2.3/remote-protection-groups

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "destroyed": true,
  - "is_local": true,
  - "remote":
    {
    "id": "string",
    "name": "string"
    },
  - "source":
    {
    "id": "string",
    "name": "string"
    },
  - "target_retention":
    {
    "all_for_sec": 86400,
    "days": 7,
    "per_day": 3
    },
  - "time_remaining": 0
  }
]

}

Eradicate a remote protection group

Eradicates a remote protection group that has been destroyed and is pending eradication. Eradicated remote protection groups cannot be recovered. Remote protection groups are destroyed through the PATCH method. The on parameter represents the name of the offload target. The ids or names parameter and the on parameter are required and must be used together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
on	string Performs the operation on the target name specified. For example, `targetName01`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/remote-protection-groups

/api/2.3/remote-protection-groups

Manage a remote protection group

Configures the snapshot retention schedule of a remote protection group. Also destroys a remote protection group from the offload target. Before the remote protection group can be destroyed, the offload target must first be removed from the protection group via the source array. The on parameter represents the name of the offload target. The ids or names parameter and the on parameter are required and must be used together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
on	string Performs the operation on the target name specified. For example, `targetName01`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

destroyed

boolean

Returns a value of true if the remote protection group has been destroyed and is pending eradication. The time_remaining value displays the amount of time left until the destroyed remote protection group is permanently eradicated. Before the time_remaining period has elapsed, the destroyed remote protection group can be recovered by setting destroyed=false. Once the time_remaining period has elapsed, the remote protection group is permanently eradicated and can no longer be recovered.

target_retention

object

The snapshot retention policy.

Responses

200

patch /api/2.3/remote-protection-groups

/api/2.3/remote-protection-groups

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"destroyed": true,
"target_retention":
{
- "all_for_sec": 86400,
- "days": 7,
- "per_day": 3
}

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "destroyed": true,
  - "is_local": true,
  - "remote":
    {
    "id": "string",
    "name": "string"
    },
  - "source":
    {
    "id": "string",
    "name": "string"
    },
  - "target_retention":
    {
    "all_for_sec": 86400,
    "days": 7,
    "per_day": 3
    },
  - "time_remaining": 0
  }
]

}

Remote Protection Group Snapshots

A remote protection group snapshot represents a protection group snapshot that resides on an offload target with the source side of the remote protection group snapshot being another array that is connected to the local array. The local array can only see the remote protection group snapshots of other arrays if the two arrays are connected.

List remote protection group snapshots

Returns a list of remote protection group snapshots.

query Parameters

destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
on	Array of strings Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, `targetName01,targetName02`.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
source_names	Array of strings Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, `name01,name02`.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/remote-protection-group-snapshots

/api/2.3/remote-protection-group-snapshots

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "name": "string",
  - "created": 1503520993,
  - "destroyed": true,
  - "is_local": true,
  - "remote":
    {
    "id": "string",
    "name": "string"
    },
  - "source":
    {
    "name": "string"
    },
  - "suffix": "string",
  - "time_remaining": 0
  }
]

}

Manage a remote protection group

Destroys a remote protection group snapshot from the offload target. The on parameter represents the name of the offload target. The ids or names parameter and the on parameter are required and must be used together.

query Parameters

names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
on	string Performs the operation on the target name specified. For example, `targetName01`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

destroyed

boolean

Responses

200

patch /api/2.3/remote-protection-group-snapshots

/api/2.3/remote-protection-group-snapshots

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"destroyed": true

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "name": "string",
  - "created": 1503520993,
  - "destroyed": true,
  - "is_local": true,
  - "remote":
    {
    "id": "string",
    "name": "string"
    },
  - "source":
    {
    "name": "string"
    },
  - "suffix": "string",
  - "time_remaining": 0
  }
]

}

Eradicate a remote protection group snapshot

Eradicates a remote protection group snapshot that has been destroyed and is pending eradication. Eradicated remote protection group snapshots cannot be recovered. Remote protection group snapshots are destroyed through the PATCH method. The names parameter represents the name of the protection group snapshot. The on parameter represents the name of the offload target. The names and on parameters are required and must be used together.

query Parameters

names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
on	string Performs the operation on the target name specified. For example, `targetName01`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/remote-protection-group-snapshots

/api/2.3/remote-protection-group-snapshots

List remote protection groups with transfer statistics

Returns a list of remote protection groups and their transfer statistics.

query Parameters

names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
on	Array of strings Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, `targetName01,targetName02`.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
source_names	Array of strings Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, `name01,name02`.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/remote-protection-group-snapshots/transfer

/api/2.3/remote-protection-group-snapshots/transfer

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "name": "string",
  - "destroyed": true,
  - "started": 0,
  - "progress": 0.66,
  - "completed": 0,
  - "data_transferred": 0,
  - "physical_bytes_written": 0
  }
],
"total":
[
- {
  - "name": "string",
  - "destroyed": true,
  - "started": 0,
  - "progress": 0.66,
  - "completed": 0,
  - "data_transferred": 0,
  - "physical_bytes_written": 0
  }
]

}

Remote Volume Snapshots

A remote volume snapshot represents a volume snapshot that resides on an offload target with the source side of the remote volume snapshot being another array that is connected to the local array. The local array can only see the remote volume snapshots of other arrays if the two arrays are connected.

List remote volume snapshots

Returns a list of remote volume snapshots.

query Parameters

destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
on	Array of strings Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, `targetName01,targetName02`.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
source_ids	Array of strings Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.
source_names	Array of strings Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, `name01,name02`.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/remote-volume-snapshots

/api/2.3/remote-volume-snapshots

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "created": 0,
  - "destroyed": true,
  - "pod":
    {
    "id": "string",
    "name": "string"
    },
  - "provisioned": 1048576,
  - "source":
    {
    "id": "string",
    "name": "string"
    },
  - "suffix": "string",
  - "time_remaining": 0,
  - "remote":
    {
    "id": "string",
    "name": "string"
    }
  }
]

}

List remote volume snapshots with transfer statistics

Returns a list of remote volume snapshots and their transfer statistics.

query Parameters

names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
on	Array of strings Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, `targetName01,targetName02`.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
source_ids	Array of strings Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.
source_names	Array of strings Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, `name01,name02`.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/remote-volume-snapshots/transfer

/api/2.3/remote-volume-snapshots/transfer

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "destroyed": true,
  - "started": 0,
  - "progress": 0.66,
  - "completed": 0,
  - "data_transferred": 0,
  - "physical_bytes_written": 0
  }
],
"total":
[
- {
  - "id": "string",
  - "name": "string",
  - "destroyed": true,
  - "started": 0,
  - "progress": 0.66,
  - "completed": 0,
  - "data_transferred": 0,
  - "physical_bytes_written": 0
  }
]

}

SMI-S

SMI-S endpoint description (placeholder)

List SMI-S settings

Displays the SMI-S settings, including the name of the array and whether SLP and WBEM-HTTPS are enabled.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/smi-s

/api/2.3/smi-s

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "slp_enabled": true,
  - "wbem_https_enabled": true
  }
]

}

Modify SLP and SMI-S

Modifies the Service Location Protocol (SLP) and the SMI-S provider, enabling or disabling them.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

slp_enabled	boolean If set to `true`, the Service Location Protocol (SLP) and its ports, TCP 427 and UDP 427, are enabled.
wbem_https_enabled	boolean If set to `true`, the SMI-S provider and its port, TCP 5989 is enabled.

Responses

200

patch /api/2.3/smi-s

/api/2.3/smi-s

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"slp_enabled": true,
"wbem_https_enabled": true

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "slp_enabled": true,
  - "wbem_https_enabled": true
  }
]

}

Software

Software to be installed on the array.

List software packages

Displays a list of available software packages.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
versions	Array of strings A comma-separated list of versions.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/software

/api/2.3/software

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "details": "string",
  - "payload_id": "4f7b319106401d072ff94808535cb3ce",
  - "progress": 0,
  - "status": "Available",
  - "upgrade_hops":
    [
    "5.0.0",
    "5.1.6",
    "5.2.3"
    ],
  - "version": "5.2.3"
  }
]

}

List software upgrades

Displays a list of software upgrades. This returns both currently running and past upgrades.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
software_ids	Array of strings A comma-separated list of software IDs.
software_names	Array of strings A comma-separated list of software names.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/software-installations

/api/2.3/software-installations

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "start_time": 1567026779000,
  - "end_time": 1567026888000,
  - "current_step_id": "string",
  - "details": "string",
  - "mode": "interactive",
  - "override_checks":
    [
    {
    "name": "HostIOCheck",
    "args": "host1,host2,host3",
    "persistent": true
    }
    ],
  - "software":
    {
    "id": "string",
    "name": "string"
    },
  - "status": "Installing"
  }
]

}

Create a software upgrade

Creates and initiates a software upgrade.

query Parameters

software_ids

required

Array of strings

A comma-separated list of software IDs.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

mode	string Which mode the upgrade is in. Valid values are `interactive`, `one_click`, and `check_only`. In `interactive` mode, the upgrade process pauses at several points, at which users must enter certain commands to proceed. In `one_click` mode, the upgrade proceeds automatically without pausing. In `check_only` mode, the upgrade only runs pre-upgrade checks and returns.
override_checks	Array of objects A list of upgrade checks whose failure is overridden during the upgrade. If any optional `args` are provided, they are validated later when the corresponding check script runs.

Responses

200

The software upgrade record was created successfully.

post /api/2.3/software-installations

/api/2.3/software-installations

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"mode": "interactive",
"override_checks":
[
- {
  - "name": "HostIOCheck",
  - "args": "host1,host2,host3",
  - "persistent": true
  }
]

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "start_time": 1567026779000,
  - "end_time": 1567026888000,
  - "current_step_id": "string",
  - "details": "string",
  - "mode": "interactive",
  - "override_checks":
    [
    {
    "name": "HostIOCheck",
    "args": "host1,host2,host3",
    "persistent": true
    }
    ],
  - "software":
    {
    "id": "string",
    "name": "string"
    },
  - "status": "Installing"
  }
]

}

Modify software upgrade

Modifies a software upgrade by continuing, retrying, or aborting it. All override_checks are updated before the command being issued if add_override_checks is present. The override_checks parameter is valid when command is continue or retry.

query Parameters

command required	string A user command that interacts with the upgrade. Commands may only be issued when the upgrade is paused. Valid values are `continue`, `retry`, and `abort`. The `continue` command continues a `paused` upgrade. The `retry` command retries the previous step. The `abort` command aborts the upgrade.
current_step_id required	string The current step `id` of the installation.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

add_override_checks

Array of objects

Adds the specified checks to the current list of override checks.

Responses

200

The command was issued and/or override_checks was updated.

patch /api/2.3/software-installations

/api/2.3/software-installations

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"add_override_checks":
[
- {
  - "name": "HostIOCheck",
  - "args": "host1,host2,host3",
  - "persistent": true
  }
]

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "start_time": 1567026779000,
  - "end_time": 1567026888000,
  - "current_step_id": "string",
  - "details": "string",
  - "mode": "interactive",
  - "override_checks":
    [
    {
    "name": "HostIOCheck",
    "args": "host1,host2,host3",
    "persistent": true
    }
    ],
  - "software":
    {
    "id": "string",
    "name": "string"
    },
  - "status": "Installing"
  }
]

}

List software upgrade steps

Displays a list of currently running and completed software upgrade steps.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
software_installation_ids	Array of strings A comma-separated list of software installation IDs.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/software-installation-steps

/api/2.3/software-installation-steps

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "start_time": 1567026779000,
  - "end_time": 1567026888000,
  - "checks":
    [
    {
    "details": "string",
    "name": "HostIOCheck",
    "overridable": true,
    "status": "string"
    }
    ],
  - "description": "string",
  - "details": "string",
  - "hop_version": "99.9.9",
  - "installation":
    {
    "id": "string",
    "name": "string"
    },
  - "status": "string"
  }
]

}

Subnets

Subnets endpoint description (placeholder)

List subnets

Displays a list of subnets with statuses and attributes.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/subnets

/api/2.3/subnets

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "name": "string",
  - "enabled": true,
  - "gateway": "string",
  - "mtu": 1280,
  - "prefix": "string",
  - "vlan": 0,
  - "interfaces":
    [
    {
    "name": "string"
    }
    ],
  - "services":
    [
    "string"
    ]
  }
]

}

Create subnet

Creates a subnet with the specified parameters.

query Parameters

names

required

Array of strings

Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

enabled	boolean Returns a value of `true` if subnet is enabled. Returns a value of `false` if subnet is disabled. If not specified, defaults to `true`.
gateway	string The IPv4 or IPv6 address of the gateway through which the specified subnet is to communicate with the network.
mtu	integer <int32> [ 1280 .. 9216 ] Maximum message transfer unit (packet) size for the subnet in bytes. MTU setting cannot exceed the MTU of the corresponding physical interface. If not specified, defaults to `1500`.
prefix	string The IPv4 or IPv6 address to be associated with the specified subnet.
vlan	integer <int32> VLAN ID number.

Responses

200

Displays the newly created subnet.

post /api/2.3/subnets

/api/2.3/subnets

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"enabled": true,
"gateway": "string",
"mtu": 1280,
"prefix": "string",
"vlan": 0

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "name": "string",
  - "enabled": true,
  - "gateway": "string",
  - "mtu": 1280,
  - "prefix": "string",
  - "vlan": 0,
  - "interfaces":
    [
    {
    "name": "string"
    }
    ],
  - "services":
    [
    "string"
    ]
  }
]

}

Delete subnet

Deletes subnets. A subnet can only be deleted if it has no interfaces. Interfaces must be removed by using the network-interfaces endpoint.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/subnets

/api/2.3/subnets

Modify subnet

Modifies one or more specified subnet properties.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

name	string A user-specified name. The name must be locally unique and can be changed.
enabled	boolean Returns a value of `true` if subnet is enabled. Returns a value of `false` if subnet is disabled. If not specified, defaults to `true`.
gateway	string The IPv4 or IPv6 address of the gateway through which the specified subnet is to communicate with the network.
mtu	integer <int32> [ 1280 .. 9216 ] Maximum message transfer unit (packet) size for the subnet in bytes. MTU setting cannot exceed the MTU of the corresponding physical interface. If not specified, defaults to `1500`.
prefix	string The IPv4 or IPv6 address to be associated with the specified subnet.
vlan	integer <int32> VLAN ID number.

Responses

200

Displays the updated subnet.

patch /api/2.3/subnets

/api/2.3/subnets

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"name": "string",
"enabled": true,
"gateway": "string",
"mtu": 1280,
"prefix": "string",
"vlan": 0

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "name": "string",
  - "enabled": true,
  - "gateway": "string",
  - "mtu": 1280,
  - "prefix": "string",
  - "vlan": 0,
  - "interfaces":
    [
    {
    "name": "string"
    }
    ],
  - "services":
    [
    "string"
    ]
  }
]

}

Support

Enables Support to fix bugs and help customers solve problems. Support tools include proxy, phonehome, and remote assist.

List connection paths

Displays connection paths between the current array and each connected array.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/support

/api/2.3/support

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "phonehome_enabled": true,
  - "proxy": "http://proxy.example.com:8080",
  - "remote_assist_active": true,
  - "remote_assist_opened": 1574460534674,
  - "remote_assist_expires": 1574633337678,
  - "remote_assist_status": "connected",
  - "remote_assist_paths":
    [
    {
    "component_name": "CT0",
    "status": "connected"
    }
    ]
  }
]

}

Create connection path

Creates a connection path from the array to another array.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

phonehome_enabled	boolean The status of phonehome. If set to `true`, enable phonehome. If set to `false`, disable phonehome.
proxy	string The value of the current proxy, which is used for connecting to cloud services such as phonehome, remote assist, etc. Specify the server name, including the scheme and proxy port number.
remote_assist_active	boolean The status of a remote assist session. If set to `true`, enable the remote assist session. If set to `false`, disable the remote assist session.

Responses

200

patch /api/2.3/support

/api/2.3/support

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"phonehome_enabled": true,
"proxy": "http://proxy.example.com:8080",
"remote_assist_active": true

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "phonehome_enabled": true,
  - "proxy": "http://proxy.example.com:8080",
  - "remote_assist_active": true,
  - "remote_assist_opened": 1574460534674,
  - "remote_assist_expires": 1574633337678,
  - "remote_assist_status": "connected",
  - "remote_assist_paths":
    [
    {
    "component_name": "CT0",
    "status": "connected"
    }
    ]
  }
]

}

List Pure Storage Support connection data

Displays information about whether the array can connect to Pure Storage Support by establishing a secure shell or secure HTTP connection and verifies that messages can be exchanged.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
test_type	string Specifies the type of test. Valid values are `all`, `phonehome`, and `remote-assist`. If not specified, defaults to `all`.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/support/test

/api/2.3/support/test

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "component_address": "10.230.94.21",
  - "component_name": "CT0",
  - "description": "Testing phonehome connectivity",
  - "destination": "ra.cloud-support.purestorage.com",
  - "enabled": true,
  - "result_details": "Timeout connecting to phonehome endpoint",
  - "success": true,
  - "test_type": "phonehome"
  }
]

}

Volumes

A volume represents a container that manages the storage space on the array. After a volume has been created, establish a host-volume connection so that the host can read data from and write data to the volume. Furthermore, protect the volume data through asynchronous replication to a remote array, synchronous replication between remote arrays, and replication to external storage systems.

List volumes

Displays a list of volumes, including those pending eradication.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/volumes

/api/2.3/volumes

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "connection_count": 0,
  - "created": 0,
  - "destroyed": true,
  - "host_encryption_key_status": "detected",
  - "provisioned": 0,
  - "qos":
    {
    "bandwidth_limit": 1048576,
    "iops_limit": 100
    },
  - "serial": "string",
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "time_remaining": 0,
  - "pod":
    {
    "id": "string",
    "name": "string"
    },
  - "source":
    {
    "id": "string",
    "name": "string"
    },
  - "subtype": "string",
  - "volume_group":
    {
    "id": "string",
    "name": "string"
    },
  - "requested_promotion_state": "string",
  - "promotion_status": "string"
  }
],
"total":
[
- {
  - "id": "string",
  - "name": "string",
  - "connection_count": 0,
  - "created": 0,
  - "destroyed": true,
  - "host_encryption_key_status": "detected",
  - "provisioned": 0,
  - "qos":
    {
    "bandwidth_limit": 1048576,
    "iops_limit": 100
    },
  - "serial": "string",
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "time_remaining": 0,
  - "pod":
    {
    "id": "string",
    "name": "string"
    },
  - "source":
    {
    "id": "string",
    "name": "string"
    },
  - "subtype": "string",
  - "volume_group":
    {
    "id": "string",
    "name": "string"
    },
  - "requested_promotion_state": "string",
  - "promotion_status": "string"
  }
]

}

Create a volume

Creates one or more virtual storage volumes of the specified size. If provisioned is not specified, the size of the new volume defaults to 1 MB in size. The names query parameter is required.

query Parameters

names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
overwrite	boolean If set to `true`, overwrites an existing volume during a volume copy operation. If set to `false` or not set at all and the target name is an existing volume, the volume copy operation fails. Required if the `source: id` or `source: name` body parameter is set and the source overwrites an existing volume during the volume copy operation.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

destroyed	boolean If set to `true`, destroys a resource. Once set to `true`, the `time_remaining` value will display the amount of time left until the destroyed resource is permanently eradicated. Before the `time_remaining` period has elapsed, the destroyed resource can be recovered by setting `destroyed=false`. Once the `time_remaining` period has elapsed, the resource is permanently eradicated and can no longer be recovered.
provisioned	integer <int64> <= 4503599627370496 Sets the virtual size of the volume. Measured in bytes.
qos	object Sets QoS limits.
source	object The source volume of a volume copy.
subtype	string The type of volume. Valid values are `protocol_endpoint` and `regular`.

Responses

200

post /api/2.3/volumes

/api/2.3/volumes

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"destroyed": true,
"provisioned": 0,
"qos":
{
- "bandwidth_limit": 1048576,
- "iops_limit": 100
},
"source":
{
- "id": "string",
- "name": "string"
},
"subtype": "string"

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "connection_count": 0,
  - "created": 0,
  - "destroyed": true,
  - "host_encryption_key_status": "detected",
  - "provisioned": 0,
  - "qos":
    {
    "bandwidth_limit": 1048576,
    "iops_limit": 100
    },
  - "serial": "string",
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "time_remaining": 0,
  - "pod":
    {
    "id": "string",
    "name": "string"
    },
  - "source":
    {
    "id": "string",
    "name": "string"
    },
  - "subtype": "string",
  - "volume_group":
    {
    "id": "string",
    "name": "string"
    },
  - "requested_promotion_state": "string",
  - "promotion_status": "string"
  }
]

}

Delete a volume

Deletes a volume that has been destroyed and is pending eradication. Eradicated volumes cannot be recovered. Volumes are destroyed using the PATCH method. The ids or names parameter is required, but they cannot be set together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/volumes

/api/2.3/volumes

Update a volume

Updates a volume, renaming, destroying, or resizing it. To rename a volume, set name to the new name. To destroy a volume, set destroyed=true. To recover a volume that has been destroyed and is pending eradication, set destroyed=false. Sets the bandwidth and IOPs limits of a volume through the respective bandwidth_limit and iops_limit parameter. Moves the volume into a pod or volume group through the respective pod or volume_group parameter. The ids or names parameter is required, but cannot be set together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
truncate	boolean If set to `true`, reduces the size of a volume during a volume resize operation. When a volume is truncated, Purity automatically takes an undo snapshot, providing a 24-hour window during which the previous contents can be retrieved. After truncating a volume, its provisioned size can be subsequently increased, but the data in truncated sectors cannot be retrieved. If set to `false` or not set at all and the volume is being reduced in size, the volume copy operation fails. Required if the `provisioned` parameter is set to a volume size that is smaller than the original size.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

destroyed	boolean If set to `true`, destroys a resource. Once set to `true`, the `time_remaining` value will display the amount of time left until the destroyed resource is permanently eradicated. Before the `time_remaining` period has elapsed, the destroyed resource can be recovered by setting `destroyed=false`. Once the `time_remaining` period has elapsed, the resource is permanently eradicated and can no longer be recovered.
name	string The new name for the resource.
pod	object Moves the volume into the specified pod.
provisioned	integer <int64> <= 4503599627370496 Updates the virtual size of the volume. Measured in bytes.
qos	object Sets QoS limits.
volume_group	object Adds the volume to the specified volume group.
requested_promotion_state	string Valid values are `promoted` and `demoted`. Patch `requested_promotion_state` to `demoted` to demote the volume so that the volume stops accepting write requests. Patch `requested_promotion_state` to `promoted` to promote the volume so that the volume starts accepting write requests.

Responses

200

patch /api/2.3/volumes

/api/2.3/volumes

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"destroyed": true,
"name": "string",
"pod":
{
- "id": "string",
- "name": "string"
},
"provisioned": 0,
"qos":
{
- "bandwidth_limit": 1048576,
- "iops_limit": 100
},
"volume_group":
{
- "id": "string",
- "name": "string"
},
"requested_promotion_state": "string"

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "connection_count": 0,
  - "created": 0,
  - "destroyed": true,
  - "host_encryption_key_status": "detected",
  - "provisioned": 0,
  - "qos":
    {
    "bandwidth_limit": 1048576,
    "iops_limit": 100
    },
  - "serial": "string",
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "time_remaining": 0,
  - "pod":
    {
    "id": "string",
    "name": "string"
    },
  - "source":
    {
    "id": "string",
    "name": "string"
    },
  - "subtype": "string",
  - "volume_group":
    {
    "id": "string",
    "name": "string"
    },
  - "requested_promotion_state": "string",
  - "promotion_status": "string"
  }
]

}

List volume performance data

Returns real-time and historical performance data, real-time latency data, and average I/O sizes for each volume and and as a total of all volumes across the entire array.

query Parameters

destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
end_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
resolution	integer <int64> >= 0 Example: 30000 The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`<object name>/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`<object name>/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution.
start_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/volumes/performance

/api/2.3/volumes/performance

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "bytes_per_mirrored_write": 0,
  - "bytes_per_op": 0,
  - "bytes_per_read": 0,
  - "bytes_per_write": 0,
  - "mirrored_write_bytes_per_sec": 0,
  - "mirrored_writes_per_sec": 0,
  - "qos_rate_limit_usec_per_mirrored_write_op": 0,
  - "qos_rate_limit_usec_per_read_op": 0,
  - "qos_rate_limit_usec_per_write_op": 0,
  - "queue_usec_per_mirrored_write_op": 0,
  - "queue_usec_per_read_op": 0,
  - "queue_usec_per_write_op": 0,
  - "read_bytes_per_sec": 0,
  - "reads_per_sec": 0,
  - "san_usec_per_mirrored_write_op": 0,
  - "san_usec_per_read_op": 0,
  - "san_usec_per_write_op": 0,
  - "service_usec_per_mirrored_write_op": 0,
  - "service_usec_per_read_op": 0,
  - "service_usec_per_write_op": 0,
  - "time": 0,
  - "usec_per_mirrored_write_op": 0,
  - "usec_per_read_op": 0,
  - "usec_per_write_op": 0,
  - "write_bytes_per_sec": 0,
  - "writes_per_sec": 0
  }
],
"total":
[
- {
  - "id": "string",
  - "name": "string",
  - "bytes_per_mirrored_write": 0,
  - "bytes_per_op": 0,
  - "bytes_per_read": 0,
  - "bytes_per_write": 0,
  - "mirrored_write_bytes_per_sec": 0,
  - "mirrored_writes_per_sec": 0,
  - "qos_rate_limit_usec_per_mirrored_write_op": 0,
  - "qos_rate_limit_usec_per_read_op": 0,
  - "qos_rate_limit_usec_per_write_op": 0,
  - "queue_usec_per_mirrored_write_op": 0,
  - "queue_usec_per_read_op": 0,
  - "queue_usec_per_write_op": 0,
  - "read_bytes_per_sec": 0,
  - "reads_per_sec": 0,
  - "san_usec_per_mirrored_write_op": 0,
  - "san_usec_per_read_op": 0,
  - "san_usec_per_write_op": 0,
  - "service_usec_per_mirrored_write_op": 0,
  - "service_usec_per_read_op": 0,
  - "service_usec_per_write_op": 0,
  - "time": 0,
  - "usec_per_mirrored_write_op": 0,
  - "usec_per_read_op": 0,
  - "usec_per_write_op": 0,
  - "write_bytes_per_sec": 0,
  - "writes_per_sec": 0
  }
]

}

List volume performance data by array

Return real-time and historical performance data, real-time latency data, and average I/O size data. The data returned is for each volume on the current array and for each volume on any remote arrays that are visible to the current array. The data is grouped by individual volumes and as a total across all volumes on each array.

query Parameters

destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
end_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
resolution	integer <int64> >= 0 Example: 30000 The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`<object name>/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`<object name>/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution.
start_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/volumes/performance/by-array

/api/2.3/volumes/performance/by-array

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "bytes_per_mirrored_write": 0,
  - "bytes_per_op": 0,
  - "bytes_per_read": 0,
  - "bytes_per_write": 0,
  - "mirrored_write_bytes_per_sec": 0,
  - "mirrored_writes_per_sec": 0,
  - "qos_rate_limit_usec_per_mirrored_write_op": 0,
  - "qos_rate_limit_usec_per_read_op": 0,
  - "qos_rate_limit_usec_per_write_op": 0,
  - "queue_usec_per_mirrored_write_op": 0,
  - "queue_usec_per_read_op": 0,
  - "queue_usec_per_write_op": 0,
  - "read_bytes_per_sec": 0,
  - "reads_per_sec": 0,
  - "san_usec_per_mirrored_write_op": 0,
  - "san_usec_per_read_op": 0,
  - "san_usec_per_write_op": 0,
  - "service_usec_per_mirrored_write_op": 0,
  - "service_usec_per_read_op": 0,
  - "service_usec_per_write_op": 0,
  - "time": 0,
  - "usec_per_mirrored_write_op": 0,
  - "usec_per_read_op": 0,
  - "usec_per_write_op": 0,
  - "write_bytes_per_sec": 0,
  - "writes_per_sec": 0,
  - "array":
    {
    "id": "string",
    "name": "string"
    }
  }
],
"total":
[
- {
  - "id": "string",
  - "name": "string",
  - "bytes_per_mirrored_write": 0,
  - "bytes_per_op": 0,
  - "bytes_per_read": 0,
  - "bytes_per_write": 0,
  - "mirrored_write_bytes_per_sec": 0,
  - "mirrored_writes_per_sec": 0,
  - "qos_rate_limit_usec_per_mirrored_write_op": 0,
  - "qos_rate_limit_usec_per_read_op": 0,
  - "qos_rate_limit_usec_per_write_op": 0,
  - "queue_usec_per_mirrored_write_op": 0,
  - "queue_usec_per_read_op": 0,
  - "queue_usec_per_write_op": 0,
  - "read_bytes_per_sec": 0,
  - "reads_per_sec": 0,
  - "san_usec_per_mirrored_write_op": 0,
  - "san_usec_per_read_op": 0,
  - "san_usec_per_write_op": 0,
  - "service_usec_per_mirrored_write_op": 0,
  - "service_usec_per_read_op": 0,
  - "service_usec_per_write_op": 0,
  - "time": 0,
  - "usec_per_mirrored_write_op": 0,
  - "usec_per_read_op": 0,
  - "usec_per_write_op": 0,
  - "write_bytes_per_sec": 0,
  - "writes_per_sec": 0,
  - "array":
    {
    "id": "string",
    "name": "string"
    }
  }
]

}

List volumes that are members of protection groups

Returns a list of volume members that belong to one or more protection groups.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/volumes/protection-groups

/api/2.3/volumes/protection-groups

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "group":
    {
    "name": "string"
    },
  - "member":
    {
    "name": "string"
    }
  }
]

}

Add a volume to a protection group

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

post /api/2.3/volumes/protection-groups

/api/2.3/volumes/protection-groups

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "group":
    {
    "name": "string"
    },
  - "member":
    {
    "name": "string"
    }
  }
]

}

Remove a volume from a protection group

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/volumes/protection-groups

/api/2.3/volumes/protection-groups

List volume space information

Returns the provisioned (virtual) size and physical storage consumption data for each volume.

query Parameters

names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
end_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
resolution	integer <int64> >= 0 Example: 30000 The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`<object name>/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`<object name>/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution.
start_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/volumes/space

/api/2.3/volumes/space

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "time": 0
  }
],
"total":
[
- {
  - "id": "string",
  - "name": "string",
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "time": 0
  }
]

}

List tags

Displays the list of tags on volume objects.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
namespaces	Array of strings A comma-separated list of namespaces.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
resource_destroyed	boolean If set to `true`, returns only objects from destroyed resources. Returns an error if the name of a live resource is specified in the `resource_names` query parameter. If set to `false`, returns only objects from live resources. Returns an error if the name of a destroyed resource is specified in the `resource_names` query parameter.
resource_ids	Array of strings A comma-separated list of resource IDs. The `resource_ids` and `resource_names` parameters cannot be provided together.
resource_names	Array of strings A comma-separated list of resource names. The `resource_ids` and `resource_names` parameters cannot be provided together.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/volumes/tags

/api/2.3/volumes/tags

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "copyable": true,
  - "key": "environment",
  - "namespace": "default",
  - "resource":
    {
    "id": "string",
    "name": "string"
    },
  - "value": "staging"
  }
]

}

Delete tags

Deletes specified tags on volume objects.

query Parameters

keys	Array of strings A comma-separated list of tag keys.
namespaces	Array of strings A comma-separated list of namespaces.
resource_ids	Array of strings A comma-separated list of resource IDs. The `resource_ids` and `resource_names` parameters cannot be provided together.
resource_names	Array of strings A comma-separated list of resource names. The `resource_ids` and `resource_names` parameters cannot be provided together.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/volumes/tags

/api/2.3/volumes/tags

Update tags

Updates tags.

query Parameters

resource_ids	Array of strings A comma-separated list of resource IDs. The `resource_ids` and `resource_names` parameters cannot be provided together.
resource_names	Array of strings A comma-separated list of resource names. The `resource_ids` and `resource_names` parameters cannot be provided together.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

A list of tags to be created or, if already existing, updated.

Array

copyable	boolean Specifies whether or not to include the tag when copying the parent resource. If set to `true`, the tag is included in resource copying. If set to `false`, the tag is not included. If not specified, defaults to `true`.
key	string Key of the tag. Supports up to 64 Unicode characters.
namespace	string Optional namespace of the tag. Namespace identifies the category of the tag. Omitting the namespace defaults to the namespace `default`. The `pure*` namespaces are reserved for plugins and integration partners. It is recommended that customers avoid using reserved namespaces.
value	string Value of the tag. Supports up to 256 Unicode characters.

Responses

200

put /api/2.3/volumes/tags/batch

/api/2.3/volumes/tags/batch

Request samples

Payload

application/json

Copy

Expand all Collapse all

[

{
- "copyable": true,
- "key": "environment",
- "namespace": "default",
- "value": "staging"
}

]

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "copyable": true,
  - "key": "environment",
  - "namespace": "default",
  - "resource":
    {
    "id": "string",
    "name": "string"
    },
  - "value": "staging"
  }
]

}

List volumes that are in volume groups

Returns a list of volumes that are in a volume group.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
group_ids	Array of strings A comma-separated list of group IDs.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_ids	Array of strings Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` and `member_names` parameters cannot be provided together.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/volumes/volume-groups

/api/2.3/volumes/volume-groups

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "group":
    {
    "id": "string",
    "name": "string"
    },
  - "member":
    {
    "id": "string",
    "name": "string"
    }
  }
]

}

Volume Groups

Volume groups organize volumes into logical groupings. If virtual volumes are configured, each volume group on the FlashArray array represents its associated virtual machine, and inside each of those volumes groups are the FlashArray volumes that are assigned to the virtual machine. Volume groups that are associated with virtual machines have names that begin with vvol- and end with the virtual machine name.

List volume groups

Displays a list of volume groups, including those pending eradication.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/volume-groups

/api/2.3/volume-groups

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "destroyed": true,
  - "qos":
    {
    "bandwidth_limit": 1048576,
    "iops_limit": 100
    },
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "time_remaining": 0,
  - "volume_count": 3
  }
],
"total":
[
- {
  - "id": "string",
  - "name": "string",
  - "destroyed": true,
  - "qos":
    {
    "bandwidth_limit": 1048576,
    "iops_limit": 100
    },
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "time_remaining": 0,
  - "volume_count": 3
  }
]

}

Create a volume group

Creates a volume group. The volume group itself does not contain any meaningful content; instead, it acts as a container that is used to organize volumes. Once a volume group has been created, volumes can be created inside the volume group or moved into and out of the volume group.

query Parameters

names

Array of strings

Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

qos

object

Responses

200

post /api/2.3/volume-groups

/api/2.3/volume-groups

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"name": "string",
"destroyed": true,
"qos":
{
- "bandwidth_limit": 1048576,
- "iops_limit": 100
}

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "destroyed": true,
  - "qos":
    {
    "bandwidth_limit": 1048576,
    "iops_limit": 100
    },
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "time_remaining": 0,
  - "volume_count": 3
  }
]

}

Delete a volume group

Deletes a volume group that has been destroyed and is pending eradication. Eradicated volume groups cannot be recovered. Volume groups are destroyed through the PATCH method. The ids or names parameter is required, but cannot be set together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
eradicate_contents	boolean Set to `true` to eradicate contents (e.g., volumes, protection groups, snapshots) and containers (e.g., pods, volume groups). This enables you to eradicate containers with contents.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/volume-groups

/api/2.3/volume-groups

Modify a volume group

Modifies a volume group. You can rename, destroy, recover, or set QoS limits for a volume group. To rename a volume group, set name to the new name. To destroy a volume group, set destroyed=true. To recover a volume group that has been destroyed and is pending eradication, set destroyed=false. Sets the bandwidth and IOPs limits of a volume group through the respective bandwidth_limit and iops_limit parameter. The ids or names parameter is required, but cannot be set together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
destroy_contents	boolean Set to `true` to destroy contents (e.g., volumes, protection groups, snapshots) and containers (e.g., pods, volume groups). This enables you to destroy containers with contents.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

name	string A user-specified name. The name must be locally unique and can be changed.
destroyed	boolean Returns a value of `true` if the volume group has been destroyed and is pending eradication. The `time_remaining` value displays the amount of time left until the destroyed volume group is permanently eradicated. Before the `time_remaining` period has elapsed, the destroyed volume group can be recovered by setting `destroyed=false`. Once the `time_remaining` period has elapsed, the volume group is permanently eradicated and can no longer be recovered.
qos	object

Responses

200

patch /api/2.3/volume-groups

/api/2.3/volume-groups

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"name": "string",
"destroyed": true,
"qos":
{
- "bandwidth_limit": 1048576,
- "iops_limit": 100
}

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "destroyed": true,
  - "qos":
    {
    "bandwidth_limit": 1048576,
    "iops_limit": 100
    },
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "time_remaining": 0,
  - "volume_count": 3
  }
]

}

List volume group performance data

Returns real-time and historical performance data, real-time latency data, and average I/O sizes for each volume group and and as a total of all volume groups across the entire array.

query Parameters

destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
end_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
resolution	integer <int64> >= 0 Example: 30000 The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`<object name>/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`<object name>/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution.
start_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/volume-groups/performance

/api/2.3/volume-groups/performance

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "bytes_per_mirrored_write": 0,
  - "bytes_per_op": 0,
  - "bytes_per_read": 0,
  - "bytes_per_write": 0,
  - "mirrored_write_bytes_per_sec": 0,
  - "mirrored_writes_per_sec": 0,
  - "qos_rate_limit_usec_per_mirrored_write_op": 0,
  - "qos_rate_limit_usec_per_read_op": 0,
  - "qos_rate_limit_usec_per_write_op": 0,
  - "queue_usec_per_mirrored_write_op": 0,
  - "queue_usec_per_read_op": 0,
  - "queue_usec_per_write_op": 0,
  - "read_bytes_per_sec": 0,
  - "reads_per_sec": 0,
  - "san_usec_per_mirrored_write_op": 0,
  - "san_usec_per_read_op": 0,
  - "san_usec_per_write_op": 0,
  - "service_usec_per_mirrored_write_op": 0,
  - "service_usec_per_read_op": 0,
  - "service_usec_per_write_op": 0,
  - "time": 0,
  - "usec_per_mirrored_write_op": 0,
  - "usec_per_read_op": 0,
  - "usec_per_write_op": 0,
  - "write_bytes_per_sec": 0,
  - "writes_per_sec": 0
  }
],
"total":
[
- {
  - "id": "string",
  - "name": "string",
  - "bytes_per_mirrored_write": 0,
  - "bytes_per_op": 0,
  - "bytes_per_read": 0,
  - "bytes_per_write": 0,
  - "mirrored_write_bytes_per_sec": 0,
  - "mirrored_writes_per_sec": 0,
  - "qos_rate_limit_usec_per_mirrored_write_op": 0,
  - "qos_rate_limit_usec_per_read_op": 0,
  - "qos_rate_limit_usec_per_write_op": 0,
  - "queue_usec_per_mirrored_write_op": 0,
  - "queue_usec_per_read_op": 0,
  - "queue_usec_per_write_op": 0,
  - "read_bytes_per_sec": 0,
  - "reads_per_sec": 0,
  - "san_usec_per_mirrored_write_op": 0,
  - "san_usec_per_read_op": 0,
  - "san_usec_per_write_op": 0,
  - "service_usec_per_mirrored_write_op": 0,
  - "service_usec_per_read_op": 0,
  - "service_usec_per_write_op": 0,
  - "time": 0,
  - "usec_per_mirrored_write_op": 0,
  - "usec_per_read_op": 0,
  - "usec_per_write_op": 0,
  - "write_bytes_per_sec": 0,
  - "writes_per_sec": 0
  }
]

}

List volume group space information

Returns the provisioned (virtual) size and physical storage consumption data for each volume group.

query Parameters

names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
end_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
resolution	integer <int64> >= 0 Example: 30000 The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`<object name>/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`<object name>/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution.
start_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/volume-groups/space

/api/2.3/volume-groups/space

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "time": 0
  }
],
"total":
[
- {
  - "id": "string",
  - "name": "string",
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "time": 0
  }
]

}

List volume groups with volumes

Returns a list of volume groups that contain volumes.

query Parameters

group_names	Array of strings Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.
member_names	Array of strings Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, `vol01,vol02`.
continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
group_ids	Array of strings A comma-separated list of group IDs.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
member_ids	Array of strings Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The `member_ids` and `member_names` parameters cannot be provided together.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/volume-groups/volumes

/api/2.3/volume-groups/volumes

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "group":
    {
    "id": "string",
    "name": "string"
    },
  - "member":
    {
    "id": "string",
    "name": "string"
    }
  }
]

}

Volume Snapshots

Volume snapshots are immutable, point-in-time images of the contents of one or more volumes. There are two types of volume snapshots: volume snapshots and protection group volume snapshots. A volume snapshot is a snapshot that captures the contents of a single volume. A protection group volume snapshot is a volume snapshot that is created from a group of volumes that are part of the same protection group. All of the volume snapshots created from a protection group snapshot are point-in-time consistent with each other.

List volume snapshots

Return a list of volume snapshots, including those pending eradication.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
source_ids	Array of strings Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.
source_names	Array of strings Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, `name01,name02`.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/volume-snapshots

/api/2.3/volume-snapshots

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "created": 0,
  - "destroyed": true,
  - "pod":
    {
    "id": "string",
    "name": "string"
    },
  - "provisioned": 1048576,
  - "source":
    {
    "id": "string",
    "name": "string"
    },
  - "suffix": "string",
  - "time_remaining": 0,
  - "serial": "string",
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "volume_group":
    {
    "id": "string",
    "name": "string"
    }
  }
],
"total":
[
- {
  - "id": "string",
  - "name": "string",
  - "created": 0,
  - "destroyed": true,
  - "pod":
    {
    "id": "string",
    "name": "string"
    },
  - "provisioned": 1048576,
  - "source":
    {
    "id": "string",
    "name": "string"
    },
  - "suffix": "string",
  - "time_remaining": 0,
  - "serial": "string",
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "volume_group":
    {
    "id": "string",
    "name": "string"
    }
  }
]

}

Generate a volume snapshot

Create a point-in-time snapshot of the contents of a volume. The source_ids or source_names parameter is required, but cannot be set together.

query Parameters

on	string Performs the operation on the target name specified. For example, `targetName01`.
source_ids	Array of strings Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.
source_names	Array of strings Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

destroyed

boolean

suffix

string

The suffix that is appended to the source_name value to generate the full volume snapshot name in the form VOL.SUFFIX. If the suffix is not specified, the system constructs the snapshot name in the form VOL.NNN, where VOL is the volume name, and NNN is a monotonically increasing number.

Responses

200

post /api/2.3/volume-snapshots

/api/2.3/volume-snapshots

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"destroyed": true,
"suffix": "string"

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "created": 0,
  - "destroyed": true,
  - "pod":
    {
    "id": "string",
    "name": "string"
    },
  - "provisioned": 1048576,
  - "source":
    {
    "id": "string",
    "name": "string"
    },
  - "suffix": "string",
  - "time_remaining": 0,
  - "serial": "string",
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "volume_group":
    {
    "id": "string",
    "name": "string"
    }
  }
]

}

Eradicate a volume snapshot

Eradicate a volume snapshot that has been destroyed and is pending eradication. Eradicated volumes snapshots cannot be recovered. Volume snapshots are destroyed through the PATCH method. The ids or names parameter is required, but cannot be set together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/volume-snapshots

/api/2.3/volume-snapshots

Manage a volume snapshot

Rename, destroy, or recover a volume snapshot. To rename the suffix of a volume snapshot, set name to the new suffix name. To recover a volume snapshot that has been destroyed and is pending eradication, set destroyed=true. The ids or names parameter is required, but cannot be set together.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

destroyed

boolean

name

string

The new name for the resource.

Responses

200

patch /api/2.3/volume-snapshots

/api/2.3/volume-snapshots

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"destroyed": true,
"name": "string"

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "created": 0,
  - "destroyed": true,
  - "pod":
    {
    "id": "string",
    "name": "string"
    },
  - "provisioned": 1048576,
  - "source":
    {
    "id": "string",
    "name": "string"
    },
  - "suffix": "string",
  - "time_remaining": 0,
  - "serial": "string",
  - "space":
    {
    "data_reduction": 0,
    "shared": 111863360624,
    "snapshots": 0,
    "system": 0,
    "thin_provisioning": 0,
    "total_physical": 0,
    "total_provisioned": 19937690345472,
    "total_reduction": 0,
    "unique": 0,
    "virtual": 0
    },
  - "volume_group":
    {
    "id": "string",
    "name": "string"
    }
  }
]

}

List volume snapshots with transfer statistics

Returns a list of volume snapshots and their transfer statistics.

query Parameters

names	Array of strings Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, `name01,name02`.
destroyed	boolean If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in seconds.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
source_ids	Array of strings Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.
source_names	Array of strings Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, `name01,name02`.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/volume-snapshots/transfer

/api/2.3/volume-snapshots/transfer

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "name": "string",
  - "destroyed": true,
  - "started": 0,
  - "progress": 0.66,
  - "completed": 0,
  - "data_transferred": 0,
  - "physical_bytes_written": 0
  }
],
"total":
[
- {
  - "id": "string",
  - "name": "string",
  - "destroyed": true,
  - "started": 0,
  - "progress": 0.66,
  - "completed": 0,
  - "data_transferred": 0,
  - "physical_bytes_written": 0
  }
]

}

List tags

Displays the list of tags on volume snapshot objects.

query Parameters

continuation_token	string A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters.
filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
namespaces	Array of strings A comma-separated list of namespaces.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
resource_destroyed	boolean If set to `true`, returns only objects from destroyed resources. Returns an error if the name of a live resource is specified in the `resource_names` query parameter. If set to `false`, returns only objects from live resources. Returns an error if the name of a destroyed resource is specified in the `resource_names` query parameter.
resource_ids	Array of strings A comma-separated list of resource IDs. The `resource_ids` and `resource_names` parameters cannot be provided together.
resource_names	Array of strings A comma-separated list of resource names. The `resource_ids` and `resource_names` parameters cannot be provided together.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/volume-snapshots/tags

/api/2.3/volume-snapshots/tags

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "copyable": true,
  - "key": "environment",
  - "namespace": "default",
  - "resource":
    {
    "id": "string",
    "name": "string"
    },
  - "value": "staging"
  }
]

}

Delete tags

Deletes specified tags on volume snapshot objects.

query Parameters

keys	Array of strings A comma-separated list of tag keys.
namespaces	Array of strings A comma-separated list of namespaces.
resource_ids	Array of strings A comma-separated list of resource IDs. The `resource_ids` and `resource_names` parameters cannot be provided together.
resource_names	Array of strings A comma-separated list of resource names. The `resource_ids` and `resource_names` parameters cannot be provided together.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/volume-snapshots/tags

/api/2.3/volume-snapshots/tags

Update tags

Updates tags.

query Parameters

resource_ids	Array of strings A comma-separated list of resource IDs. The `resource_ids` and `resource_names` parameters cannot be provided together.
resource_names	Array of strings A comma-separated list of resource names. The `resource_ids` and `resource_names` parameters cannot be provided together.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

A list of tags to be created or modified.

Array

copyable	boolean Specifies whether or not to include the tag when copying the parent resource. If set to `true`, the tag is included in resource copying. If set to `false`, the tag is not included. If not specified, defaults to `true`.
key	string Key of the tag. Supports up to 64 Unicode characters.
namespace	string Optional namespace of the tag. Namespace identifies the category of the tag. Omitting the namespace defaults to the namespace `default`. The `pure*` namespaces are reserved for plugins and integration partners. It is recommended that customers avoid using reserved namespaces.
value	string Value of the tag. Supports up to 256 Unicode characters.

Responses

200

put /api/2.3/volume-snapshots/tags/batch

/api/2.3/volume-snapshots/tags/batch

Request samples

Payload

application/json

Copy

Expand all Collapse all

[

{
- "copyable": true,
- "key": "environment",
- "namespace": "default",
- "value": "staging"
}

]

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "copyable": true,
  - "key": "environment",
  - "namespace": "default",
  - "resource":
    {
    "id": "string",
    "name": "string"
    },
  - "value": "staging"
  }
]

}

Pod Replica Links

List pod replica links

Displays the list of pod replica links that are configured between arrays.

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
local_pod_ids	Array of strings A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `local_pod_names` query parameter.
local_pod_names	Array of strings A comma-separated list of local pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `local_pod_ids` query parameter.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
remote_ids	Array of strings A comma-separated list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_names` query parameter.
remote_names	Array of strings A comma-separated list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_ids` query parameter.
remote_pod_ids	Array of strings A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_pod_names` query parameter.
remote_pod_names	Array of strings A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_pod_ids` query parameter.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/pod-replica-links

/api/2.3/pod-replica-links

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "direction": "string",
  - "lag": 0,
  - "local_pod":
    {
    "id": "string",
    "name": "string"
    },
  - "paused": true,
  - "recovery_point": 1565034592494,
  - "remote_pod":
    {
    "id": "string",
    "name": "string"
    },
  - "remotes":
    [
    {
    "id": "string",
    "name": "string"
    }
    ],
  - "status": "string"
  }
]

}

Create pod replica links

Creates pod replica links between two arrays. The local_pod_names and remote_pod_names are required. Valid values are replicating, baselining, paused, unhealthy, quiescing, and quiesced. A status of replicating indicates that the source array is replicating to the target array. A status of baselining indicates that the the initial version of the dataset is being sent. During this phase, you cannot promote the target pod. In addition, changing the link direction might trigger the baselining status to recur. A status of paused indicates that data transfer between objects has stopped. A status of unhealthy indicates that the link is currently unhealthy and customers must perform some health checks to determine the cause. A status of quiescing indicates that the source pod is not accepting new write requests but the most recent changes to the source have not arrived on the target. A status of quiesced indicates that the source pod has been demoted and all changes have been replicated to the target pod.

query Parameters

local_pod_ids	Array of strings A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `local_pod_names` query parameter.
local_pod_names	Array of strings A comma-separated list of local pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `local_pod_ids` query parameter.
remote_ids	Array of strings A comma-separated list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_names` query parameter.
remote_names	Array of strings A comma-separated list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_ids` query parameter.
remote_pod_ids	Array of strings A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_pod_names` query parameter.
remote_pod_names	Array of strings A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_pod_ids` query parameter.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

post /api/2.3/pod-replica-links

/api/2.3/pod-replica-links

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "id": "string",
  - "direction": "string",
  - "lag": 0,
  - "local_pod":
    {
    "id": "string",
    "name": "string"
    },
  - "paused": true,
  - "recovery_point": 1565034592494,
  - "remote_pod":
    {
    "id": "string",
    "name": "string"
    },
  - "remotes":
    [
    {
    "id": "string",
    "name": "string"
    }
    ],
  - "status": "string"
  }
]

}

Modify pod replica links

Modifies pod replica links. The local_pod_names and remote_pod_names are required. Valid values are replicating, baselining, paused, unhealthy, quiescing, and quiesced. A status of replicating indicates that the source array is replicating to the target array. A status of baselining indicates that the the initial version of the dataset is being sent. During this phase, you cannot promote the target pod. In addition, changing the link direction might trigger the baselining status to recur. A status of paused indicates that data transfer between objects has stopped. A status of unhealthy indicates that the link is currently unhealthy and customers must perform some health checks to determine the cause. A status of quiescing indicates that the source pod is not accepting new write requests but the most recent changes to the source have not arrived on the target. A status of quiesced indicates that the source pod has been demoted and all changes have been replicated to the target pod.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
local_pod_ids	Array of strings A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `local_pod_names` query parameter.
local_pod_names	Array of strings A comma-separated list of local pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `local_pod_ids` query parameter.
remote_ids	Array of strings A comma-separated list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_names` query parameter.
remote_names	Array of strings A comma-separated list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_ids` query parameter.
remote_pod_ids	Array of strings A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_pod_names` query parameter.
remote_pod_names	Array of strings A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_pod_ids` query parameter.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Request Body schema: application/json

paused

boolean

Returns a value of true if the replica link is to be created in a paused state. Returns a value of false if the replica link is to be created not in a paused state. If not specified, defaults to false.

Responses

200

patch /api/2.3/pod-replica-links

/api/2.3/pod-replica-links

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"paused": true

}

Response samples

application/json

Copy

Expand all Collapse all

{

"items":
[
- {
  - "id": "string",
  - "direction": "string",
  - "lag": 0,
  - "local_pod":
    {
    "id": "string",
    "name": "string"
    },
  - "paused": true,
  - "recovery_point": 1565034592494,
  - "remote_pod":
    {
    "id": "string",
    "name": "string"
    },
  - "remotes":
    [
    {
    "id": "string",
    "name": "string"
    }
    ],
  - "status": "string"
  }
]

}

Delete pod replica links

Deletes pod replica links. The local_pod_names and remote_pod_names are required. Valid values are replicating, baselining, paused, unhealthy, quiescing, and quiesced. A status of replicating indicates that the source array is replicating to the target array. A status of baselining indicates that the the initial version of the dataset is being sent. During this phase, you cannot promote the target pod. In addition, changing the link direction might trigger the baselining status to recur. A status of paused indicates that data transfer between objects has stopped. A status of unhealthy indicates that the link is currently unhealthy and customers must perform some health checks to determine the cause. A status of quiescing indicates that the source pod is not accepting new write requests but the most recent changes to the source have not arrived on the target. A status of quiesced indicates that the source pod has been demoted and all changes have been replicated to the target pod.

query Parameters

ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
local_pod_ids	Array of strings A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `local_pod_names` query parameter.
local_pod_names	Array of strings A comma-separated list of local pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `local_pod_ids` query parameter.
remote_pod_ids	Array of strings A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_pod_names` query parameter.
remote_pod_names	Array of strings A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_pod_ids` query parameter.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

delete /api/2.3/pod-replica-links

/api/2.3/pod-replica-links

<no summary>

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
end_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
resolution	integer <int64> >= 0 Example: 30000 The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`<object name>/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`<object name>/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution.
start_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
local_pod_ids	Array of strings A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `local_pod_names` query parameter.
local_pod_names	Array of strings A comma-separated list of local pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `local_pod_ids` query parameter.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
remote_ids	Array of strings A comma-separated list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_names` query parameter.
remote_names	Array of strings A comma-separated list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_ids` query parameter.
remote_pod_ids	Array of strings A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_pod_names` query parameter.
remote_pod_names	Array of strings A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_pod_ids` query parameter.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/pod-replica-links/lag

/api/2.3/pod-replica-links/lag

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "direction": "string",
  - "lag":
    {
    "avg": 0,
    "max": 0
    },
  - "local_pod":
    {
    "id": "string",
    "name": "string"
    },
  - "recovery_point": 1565034592494,
  - "remote_pod":
    {
    "id": "string",
    "name": "string"
    },
  - "remotes":
    [
    {
    "id": "string",
    "name": "string"
    }
    ],
  - "status": "string",
  - "time": 0
  }
]

}

<no summary>

query Parameters

filter	string Narrows down the results to only the response objects that satisfy the filter criteria.
ids	Array of strings Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The `ids` and `names` parameters cannot be provided together.
end_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
resolution	integer <int64> >= 0 Example: 30000 The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`<object name>/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`<object name>/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution.
start_time	integer <int64> Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.
limit	integer <int32> >= 1 Example: 10 Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.
local_pod_ids	Array of strings A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `local_pod_names` query parameter.
local_pod_names	Array of strings A comma-separated list of local pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `local_pod_ids` query parameter.
offset	integer <int32> >= 0 Example: 10 The starting position based on the results of the query in relation to the full set of response objects returned.
remote_ids	Array of strings A comma-separated list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_names` query parameter.
remote_names	Array of strings A comma-separated list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_ids` query parameter.
remote_pod_ids	Array of strings A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_pod_names` query parameter.
remote_pod_names	Array of strings A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `remote_pod_ids` query parameter.
sort	Array of strings Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.
total_item_count	boolean If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.
total_only	boolean If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty.

header Parameters

Authorization	string Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)
X-Request-ID	string Supplied by client during request or generated by server.

Responses

200

get /api/2.3/pod-replica-links/performance/replication

/api/2.3/pod-replica-links/performance/replication

Response samples

application/json

Copy

Expand all Collapse all

{

"more_items_remaining": false,
"total_item_count": 0,
"continuation_token": "string",
"items":
[
- {
  - "id": "string",
  - "bytes_per_sec_from_remote": 0,
  - "bytes_per_sec_to_remote": 0,
  - "bytes_per_sec_total": 0,
  - "direction": "string",
  - "local_pod":
    {
    "id": "string",
    "name": "string"
    },
  - "remote_pod":
    {
    "id": "string",
    "name": "string"
    },
  - "remotes":
    [
    {
    "id": "string",
    "name": "string"
    }
    ],
  - "time": 0
  }
],
"total":
[
- {
  - "id": "string",
  - "bytes_per_sec_from_remote": 0,
  - "bytes_per_sec_to_remote": 0,
  - "bytes_per_sec_total": 0,
  - "direction": "string",
  - "local_pod":
    {
    "id": "string",
    "name": "string"
    },
  - "remote_pod":
    {
    "id": "string",
    "name": "string"
    },
  - "remotes":
    [
    {
    "id": "string",
    "name": "string"
    }
    ],
  - "time": 0
  }
]

}